diff --git a/.eslintignore b/.eslintignore index 477ad808b79..db7cd052735 100644 --- a/.eslintignore +++ b/.eslintignore @@ -24,6 +24,8 @@ /packages/data-worker/addon/ /packages/holodeck/ /packages/schema-record/ +/packages/schema/ +/tests/schema/ **/DEBUG/ diff --git a/packages/schema/.npmignore b/packages/schema/.npmignore new file mode 100644 index 00000000000..07e6e472cc7 --- /dev/null +++ b/packages/schema/.npmignore @@ -0,0 +1 @@ +/node_modules diff --git a/packages/schema/LICENSE.md b/packages/schema/LICENSE.md new file mode 100644 index 00000000000..b0ca693ab2d --- /dev/null +++ b/packages/schema/LICENSE.md @@ -0,0 +1,12 @@ +The MIT License (MIT) + +Copyright (C) 2023 EmberData and WarpDrive contributors +Copyright (C) 2017-2022 Ember.js contributors +Portions Copyright (C) 2011-2017 Tilde, Inc. and contributors. +Portions Copyright (C) 2011 LivingSocial Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/schema/NCC-1701-a-blue.svg b/packages/schema/NCC-1701-a-blue.svg new file mode 100644 index 00000000000..3b46f232c1a --- /dev/null +++ b/packages/schema/NCC-1701-a-blue.svg @@ -0,0 +1,4 @@ + + + + diff --git a/packages/schema/NCC-1701-a.svg b/packages/schema/NCC-1701-a.svg new file mode 100644 index 00000000000..8ee688dcf30 --- /dev/null +++ b/packages/schema/NCC-1701-a.svg @@ -0,0 +1,4 @@ + + + + diff --git a/packages/schema/README.md b/packages/schema/README.md new file mode 100644 index 00000000000..44e945412bf --- /dev/null +++ b/packages/schema/README.md @@ -0,0 +1,120 @@ +

+ + +

+ +

:electron: Declarative Schema Parser

+

Build faster with better DX

+ +

+ WarpDrive Schema +

+ +`@warp-drive/schema` allows you to easily use the typescript you already know as a statically analyzable schema language. + +Its like GraphQL, RPC, or Protobuf... but for anything! + +## Usage + +> ⚠️ Private + +This package may currently only be used within EmberData. A public version is coming soon 💜 + +#### 🔜 Soon + +Scaffold the schema for a `User` resource + +```no-highlight +npx -p @warp-drive-schema resource user +``` + +Parse Schemas + +```no-highlight +npx -p @warp-drive/schema parse +``` + +## How it works + +The parser expects a json config file. + +```ts +{ + "schemas": "./src/schemas", + "dest": "./dist", +} +``` + +### ♥️ Credits + +
+ Brought to you with ♥️ love by 🐹 Ember + + +
diff --git a/packages/schema/package.json b/packages/schema/package.json new file mode 100644 index 00000000000..e9ed2ff5ff8 --- /dev/null +++ b/packages/schema/package.json @@ -0,0 +1,56 @@ +{ + "name": "@warp-drive/schema", + "version": "5.5.0-alpha.11", + "private": true, + "description": "Parse Declarative Typescript into JSON Schemas", + "keywords": [ + "typescript", + "schema", + "parser", + "GraphQL", + "tRPC", + "MSW", + "EmberData", + "Tanstack" + ], + "repository": { + "type": "git", + "url": "git+ssh://git@github.com:emberjs/data.git", + "directory": "packages/schema" + }, + "license": "MIT", + "author": "Chris Thoburn ", + "scripts": { + "build:parse": "bun build src/parse.ts --compile --outfile parse", + "build:scaffold": "bun build src/scaffold.ts --compile --outfile scaffold", + "build": "pnpm run build:parse && pnpm run build:scaffold", + "prepack": "pnpm build" + }, + "files": [ + "README.md", + "LICENSE.md", + "NCC-1701-a.svg", + "NCC-1701-a-blue.svg" + ], + "bin": { + "parse": "./parse", + "resource": "./scaffold resource" + }, + "main": "src/index.ts", + "peerDependencies": { + "typescript": "^5.0.0" + }, + "dependencies": { + "chalk": "^5.3.0" + }, + "devDependencies": { + "bun-types": "1.0.4-canary.20231004T140131" + }, + "engines": { + "node": ">= 18.*" + }, + "volta": { + "extends": "../../package.json" + }, + "packageManager": "pnpm@8.8.0" +} \ No newline at end of file diff --git a/packages/schema/parse b/packages/schema/parse new file mode 100755 index 00000000000..997d67d9a01 Binary files /dev/null and b/packages/schema/parse differ diff --git a/packages/schema/parse-usage.png b/packages/schema/parse-usage.png new file mode 100644 index 00000000000..2339010ee76 Binary files /dev/null and b/packages/schema/parse-usage.png differ diff --git a/packages/schema/scaffold b/packages/schema/scaffold new file mode 100755 index 00000000000..e1e5e81b764 Binary files /dev/null and b/packages/schema/scaffold differ diff --git a/packages/schema/scaffold-resource.png b/packages/schema/scaffold-resource.png new file mode 100644 index 00000000000..1292c4051da Binary files /dev/null and b/packages/schema/scaffold-resource.png differ diff --git a/packages/schema/src/parse.ts b/packages/schema/src/parse.ts new file mode 100644 index 00000000000..5eec2faf4ae --- /dev/null +++ b/packages/schema/src/parse.ts @@ -0,0 +1,3 @@ +async function main() {} + +await main(); diff --git a/packages/schema/src/scaffold.ts b/packages/schema/src/scaffold.ts new file mode 100644 index 00000000000..5eec2faf4ae --- /dev/null +++ b/packages/schema/src/scaffold.ts @@ -0,0 +1,3 @@ +async function main() {} + +await main(); diff --git a/packages/schema/tsconfig.json b/packages/schema/tsconfig.json new file mode 100644 index 00000000000..fee9ef4955e --- /dev/null +++ b/packages/schema/tsconfig.json @@ -0,0 +1,17 @@ +{ + "compilerOptions": { + "lib": ["ESNext"], + "module": "esnext", + "target": "esnext", + "moduleResolution": "bundler", + "moduleDetection": "force", + "allowImportingTsExtensions": true, + "strict": true, + "downlevelIteration": true, + "skipLibCheck": true, + "allowSyntheticDefaultImports": true, + "forceConsistentCasingInFileNames": true, + "allowJs": true, + "noEmit": true + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2ec99807e42..d16fa4d1489 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1105,6 +1105,16 @@ importers: '@ember/string': injected: true + packages/schema: + dependencies: + chalk: + specifier: ^5.3.0 + version: 5.3.0 + devDependencies: + bun-types: + specifier: 1.0.4-canary.20231004T140131 + version: 1.0.4-canary.20231004T140131 + packages/schema-record: dependencies: '@ember-data/private-build-infra': @@ -8527,6 +8537,10 @@ packages: dependencies: semver: 7.5.4 + /bun-types@1.0.4-canary.20231004T140131: + resolution: {integrity: sha512-k9DSGP8+mJTJHY/87Q2NqixeXRw04mgIHDSIi29D/bhOu7HqZbO1l+48/aiS8miUpj59ZgJVgpSi+Px33yMCJQ==} + dev: true + /bundle-name@3.0.0: resolution: {integrity: sha512-PKA4BeSvBpQKQ8iPOGCSiell+N8P+Tf1DlwqmYhpe2gAhKPHn8EYOxVT+ShuGmhg8lN8XiSlS80yiExKXrURlw==} engines: {node: '>=12'} diff --git a/tests/schema/input/schema.json b/tests/schema/input/schema.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/tests/schema/input/schemas/user.ts b/tests/schema/input/schemas/user.ts new file mode 100644 index 00000000000..07887b47a8e --- /dev/null +++ b/tests/schema/input/schemas/user.ts @@ -0,0 +1,7 @@ +class User { + declare id: string; + declare firstName: string; + declare lastName: string; +} + +export default User;