@osdk/maker 0.14.0-beta.7 → 0.14.0-beta.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/build/browser/api/code-snippets/createCodeSnippets.js +91 -0
- package/build/browser/api/code-snippets/createCodeSnippets.js.map +1 -0
- package/build/browser/api/code-snippets/snippetTypes.js +60 -0
- package/build/browser/api/code-snippets/snippetTypes.js.map +1 -0
- package/build/browser/api/defineDeleteInterfaceObjectAction.js +2 -2
- package/build/browser/api/defineDeleteInterfaceObjectAction.js.map +1 -1
- package/build/browser/api/defineOntology.js +5 -1
- package/build/browser/api/defineOntology.js.map +1 -1
- package/build/browser/api/test/actions.test.js +9 -9
- package/build/browser/api/test/actions.test.js.map +1 -1
- package/build/browser/cli/main.js +23 -4
- package/build/browser/cli/main.js.map +1 -1
- package/build/cjs/index.cjs +1300 -40
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/index.d.cts +1 -1
- package/build/esm/api/code-snippets/createCodeSnippets.js +91 -0
- package/build/esm/api/code-snippets/createCodeSnippets.js.map +1 -0
- package/build/esm/api/code-snippets/snippetTypes.js +60 -0
- package/build/esm/api/code-snippets/snippetTypes.js.map +1 -0
- package/build/esm/api/defineDeleteInterfaceObjectAction.js +2 -2
- package/build/esm/api/defineDeleteInterfaceObjectAction.js.map +1 -1
- package/build/esm/api/defineOntology.js +5 -1
- package/build/esm/api/defineOntology.js.map +1 -1
- package/build/esm/api/test/actions.test.js +9 -9
- package/build/esm/api/test/actions.test.js.map +1 -1
- package/build/esm/cli/main.js +23 -4
- package/build/esm/cli/main.js.map +1 -1
- package/build/types/api/code-snippets/createCodeSnippets.d.ts +2 -0
- package/build/types/api/code-snippets/createCodeSnippets.d.ts.map +1 -0
- package/build/types/api/code-snippets/snippetTypes.d.ts +23 -0
- package/build/types/api/code-snippets/snippetTypes.d.ts.map +1 -0
- package/build/types/api/defineOntology.d.ts +1 -1
- package/build/types/api/defineOntology.d.ts.map +1 -1
- package/package.json +4 -3
package/build/esm/cli/main.js
CHANGED
|
@@ -24,7 +24,7 @@ import { defineOntology } from "../api/defineOntology.js";
|
|
|
24
24
|
const apiNamespaceRegex = /^[a-z0-9-]+(\.[a-z0-9-]+)*\.$/;
|
|
25
25
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
|
|
26
26
|
export default async function main(args = process.argv) {
|
|
27
|
-
const commandLineOpts = await yargs(hideBin(args)).version("0.14.0-beta.
|
|
27
|
+
const commandLineOpts = await yargs(hideBin(args)).version("0.14.0-beta.9" ?? "").wrap(Math.min(150, yargs().terminalWidth())).strict().help().options({
|
|
28
28
|
input: {
|
|
29
29
|
alias: "i",
|
|
30
30
|
describe: "Input file",
|
|
@@ -68,6 +68,22 @@ export default async function main(args = process.argv) {
|
|
|
68
68
|
type: "string",
|
|
69
69
|
coerce: path.resolve
|
|
70
70
|
},
|
|
71
|
+
generateCodeSnippets: {
|
|
72
|
+
describe: "Enable code snippet files creation",
|
|
73
|
+
type: "boolean",
|
|
74
|
+
default: false
|
|
75
|
+
},
|
|
76
|
+
codeSnippetPackageName: {
|
|
77
|
+
describe: "The package name that will be displayed in the code snippets",
|
|
78
|
+
default: "",
|
|
79
|
+
type: "string"
|
|
80
|
+
},
|
|
81
|
+
codeSnippetDir: {
|
|
82
|
+
describe: "Directory for generated code snippet files",
|
|
83
|
+
type: "string",
|
|
84
|
+
default: "./",
|
|
85
|
+
coerce: path.resolve
|
|
86
|
+
},
|
|
71
87
|
randomnessKey: {
|
|
72
88
|
describe: "Value used to assure uniqueness of entities",
|
|
73
89
|
type: "string",
|
|
@@ -81,10 +97,13 @@ export default async function main(args = process.argv) {
|
|
|
81
97
|
!apiNamespaceRegex.test(apiNamespace) ? process.env.NODE_ENV !== "production" ? invariant(false, "API namespace is invalid! It is expected to conform to ^[a-z0-9-]+(\.[a-z0-9-]+)*\.$") : invariant(false) : void 0;
|
|
82
98
|
}
|
|
83
99
|
consola.info(`Loading ontology from ${commandLineOpts.input}`);
|
|
100
|
+
if (!commandLineOpts.generateCodeSnippets && (commandLineOpts.codeSnippetPackageName !== "" || commandLineOpts.codeSnippetDir !== path.resolve("./"))) {
|
|
101
|
+
consola.info("Package name and/or directory supplied for code snippets, but code snippet generation is false.");
|
|
102
|
+
}
|
|
84
103
|
if (commandLineOpts.randomnessKey !== undefined) {
|
|
85
104
|
!uuidRegex.test(commandLineOpts.randomnessKey) ? process.env.NODE_ENV !== "production" ? invariant(false, "Supplied randomness key is not a uuid and shouldn't be used as a uniqueness guarantee") : invariant(false) : void 0;
|
|
86
105
|
}
|
|
87
|
-
const ontologyIr = await loadOntology(commandLineOpts.input, apiNamespace, commandLineOpts.outputDir, commandLineOpts.dependencies, commandLineOpts.randomnessKey);
|
|
106
|
+
const ontologyIr = await loadOntology(commandLineOpts.input, apiNamespace, commandLineOpts.outputDir, commandLineOpts.dependencies, commandLineOpts.generateCodeSnippets, commandLineOpts.codeSnippetPackageName, commandLineOpts.codeSnippetDir, commandLineOpts.randomnessKey);
|
|
88
107
|
consola.info(`Saving ontology to ${commandLineOpts.output}`);
|
|
89
108
|
await fs.writeFile(commandLineOpts.output, JSON.stringify(ontologyIr, null, 2));
|
|
90
109
|
// No point in generating block if there aren't any value types
|
|
@@ -92,8 +111,8 @@ export default async function main(args = process.argv) {
|
|
|
92
111
|
await fs.writeFile(commandLineOpts.valueTypesOutput, JSON.stringify(ontologyIr.valueTypes, null, 2));
|
|
93
112
|
}
|
|
94
113
|
}
|
|
95
|
-
async function loadOntology(input, apiNamespace, outputDir, dependencyFile, randomnessKey) {
|
|
96
|
-
const q = await defineOntology(apiNamespace, async () => await import(input), outputDir, dependencyFile, randomnessKey);
|
|
114
|
+
async function loadOntology(input, apiNamespace, outputDir, dependencyFile, generateCodeSnippets, snippetPackageName, codeSnippetDir, randomnessKey) {
|
|
115
|
+
const q = await defineOntology(apiNamespace, async () => await import(input), outputDir, dependencyFile, generateCodeSnippets, snippetPackageName, codeSnippetDir, randomnessKey);
|
|
97
116
|
return q;
|
|
98
117
|
}
|
|
99
118
|
//# sourceMappingURL=main.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.js","names":["consola","fs","path","invariant","yargs","hideBin","defineOntology","apiNamespaceRegex","uuidRegex","main","args","process","argv","commandLineOpts","version","wrap","Math","min","terminalWidth","strict","help","options","input","alias","describe","type","default","coerce","resolve","output","apiNamespace","snapshotDir","outputDir","valueTypesOutput","dependencies","randomnessKey","parseAsync","length","slice","env","NODE_ENV","test","info","undefined","ontologyIr","loadOntology","writeFile","JSON","stringify","valueTypes","importedValueTypes","dependencyFile","q"],"sources":["main.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { consola } from \"consola\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\nimport invariant from \"tiny-invariant\";\nimport yargs from \"yargs\";\nimport { hideBin } from \"yargs/helpers\";\nimport { defineOntology } from \"../api/defineOntology.js\";\n\nconst apiNamespaceRegex = /^[a-z0-9-]+(\\.[a-z0-9-]+)*\\.$/;\nconst uuidRegex =\n /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;\n\nexport default async function main(\n args: string[] = process.argv,\n): Promise<void> {\n const commandLineOpts: {\n input: string;\n output: string;\n apiNamespace: string;\n snapshotDir: string;\n valueTypesOutput: string;\n outputDir?: string;\n dependencies?: string;\n randomnessKey?: string;\n } = await yargs(hideBin(args))\n .version(process.env.PACKAGE_VERSION ?? \"\")\n .wrap(Math.min(150, yargs().terminalWidth()))\n .strict()\n .help()\n .options({\n input: {\n alias: \"i\",\n describe: \"Input file\",\n type: \"string\",\n default: \".ontology/ontology.ts\",\n coerce: path.resolve,\n },\n output: {\n alias: \"o\",\n describe: \"Output file\",\n type: \"string\",\n default: \"ontology.json\",\n coerce: path.resolve,\n },\n apiNamespace: {\n describe: \"Api name prefix for namespaced ontology types\",\n type: \"string\",\n default: \"\",\n },\n snapshotDir: {\n alias: \"s\",\n describe: \"Snapshot directory\",\n type: \"string\",\n default: \"snapshots\",\n coerce: path.resolve,\n },\n outputDir: {\n alias: \"d\",\n describe: \"Directory for generated ontology entities\",\n type: \"string\",\n coerce: path.resolve,\n },\n valueTypesOutput: {\n describe: \"Value Type Output File\",\n type: \"string\",\n default: \"value-types.json\",\n coerce: path.resolve,\n },\n dependencies: {\n describe: \"File to write dependencies to\",\n type: \"string\",\n coerce: path.resolve,\n },\n randomnessKey: {\n describe: \"Value used to assure uniqueness of entities\",\n type: \"string\",\n coerce: path.resolve,\n },\n })\n .parseAsync();\n let apiNamespace = \"\";\n if (commandLineOpts.apiNamespace.length !== 0) {\n apiNamespace = (commandLineOpts.apiNamespace.slice(-1) !== \".\")\n ? commandLineOpts.apiNamespace + \".\"\n : commandLineOpts.apiNamespace;\n invariant(apiNamespace.length < 1024, \"API namespace is too long.\");\n invariant(\n apiNamespaceRegex.test(apiNamespace),\n \"API namespace is invalid! It is expected to conform to ^[a-z0-9-]+(\\.[a-z0-9-]+)*\\.$\",\n );\n }\n consola.info(`Loading ontology from ${commandLineOpts.input}`);\n\n if (commandLineOpts.randomnessKey !== undefined) {\n invariant(\n uuidRegex.test(commandLineOpts.randomnessKey),\n \"Supplied randomness key is not a uuid and shouldn't be used as a uniqueness guarantee\",\n );\n }\n\n const ontologyIr = await loadOntology(\n commandLineOpts.input,\n apiNamespace,\n commandLineOpts.outputDir,\n commandLineOpts.dependencies,\n commandLineOpts.randomnessKey,\n );\n\n consola.info(`Saving ontology to ${commandLineOpts.output}`);\n await fs.writeFile(\n commandLineOpts.output,\n JSON.stringify(\n ontologyIr,\n null,\n 2,\n ),\n );\n // No point in generating block if there aren't any value types\n if (\n ontologyIr.valueTypes.valueTypes.length > 0\n || ontologyIr.importedValueTypes.valueTypes.length > 0\n ) {\n await fs.writeFile(\n commandLineOpts.valueTypesOutput,\n JSON.stringify(\n ontologyIr.valueTypes,\n null,\n 2,\n ),\n );\n }\n}\n\nasync function loadOntology(\n input: string,\n apiNamespace: string,\n outputDir: string | undefined,\n dependencyFile: string | undefined,\n randomnessKey?: string,\n) {\n const q = await defineOntology(\n apiNamespace,\n async () => await import(input),\n outputDir,\n dependencyFile,\n randomnessKey,\n );\n return q;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,OAAO,QAAQ,SAAS;AACjC,OAAO,KAAKC,EAAE,MAAM,kBAAkB;AACtC,OAAO,KAAKC,IAAI,MAAM,WAAW;AACjC,OAAOC,SAAS,MAAM,gBAAgB;AACtC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,OAAO,QAAQ,eAAe;AACvC,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,MAAMC,iBAAiB,GAAG,+BAA+B;AACzD,MAAMC,SAAS,GACb,gEAAgE;AAElE,eAAe,eAAeC,IAAIA,CAChCC,IAAc,GAAGC,OAAO,CAACC,IAAI,EACd;EACf,MAAMC,eASL,GAAG,MAAMT,KAAK,CAACC,OAAO,CAACK,IAAI,CAAC,CAAC,CAC3BI,OAAO,CAAC,mBAA+B,EAAE,CAAC,CAC1CC,IAAI,CAACC,IAAI,CAACC,GAAG,CAAC,GAAG,EAAEb,KAAK,CAAC,CAAC,CAACc,aAAa,CAAC,CAAC,CAAC,CAAC,CAC5CC,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,OAAO,CAAC;IACPC,KAAK,EAAE;MACLC,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,YAAY;MACtBC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,uBAAuB;MAChCC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDC,MAAM,EAAE;MACNN,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,aAAa;MACvBC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,eAAe;MACxBC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDE,YAAY,EAAE;MACZN,QAAQ,EAAE,+CAA+C;MACzDC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE;IACX,CAAC;IACDK,WAAW,EAAE;MACXR,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,oBAAoB;MAC9BC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,WAAW;MACpBC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDI,SAAS,EAAE;MACTT,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,2CAA2C;MACrDC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDK,gBAAgB,EAAE;MAChBT,QAAQ,EAAE,wBAAwB;MAClCC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,kBAAkB;MAC3BC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDM,YAAY,EAAE;MACZV,QAAQ,EAAE,+BAA+B;MACzCC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDO,aAAa,EAAE;MACbX,QAAQ,EAAE,6CAA6C;MACvDC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf;EACF,CAAC,CAAC,CACDQ,UAAU,CAAC,CAAC;EACf,IAAIN,YAAY,GAAG,EAAE;EACrB,IAAIjB,eAAe,CAACiB,YAAY,CAACO,MAAM,KAAK,CAAC,EAAE;IAC7CP,YAAY,GAAIjB,eAAe,CAACiB,YAAY,CAACQ,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,GAC1DzB,eAAe,CAACiB,YAAY,GAAG,GAAG,GAClCjB,eAAe,CAACiB,YAAY;IAChC,EAAUA,YAAY,CAACO,MAAM,GAAG,IAAI,IAAA1B,OAAA,CAAA4B,GAAA,CAAAC,QAAA,oBAApCrC,SAAS,QAA6B,4BAA4B,IAAlEA,SAAS;IACT,CACEI,iBAAiB,CAACkC,IAAI,CAACX,YAAY,CAAC,GAAAnB,OAAA,CAAA4B,GAAA,CAAAC,QAAA,oBADtCrC,SAAS,QAEP,sFAAsF,IAFxFA,SAAS;EAIX;EACAH,OAAO,CAAC0C,IAAI,CAAC,yBAAyB7B,eAAe,CAACS,KAAK,EAAE,CAAC;EAE9D,IAAIT,eAAe,CAACsB,aAAa,KAAKQ,SAAS,EAAE;IAC/C,CACEnC,SAAS,CAACiC,IAAI,CAAC5B,eAAe,CAACsB,aAAa,CAAC,GAAAxB,OAAA,CAAA4B,GAAA,CAAAC,QAAA,oBAD/CrC,SAAS,QAEP,uFAAuF,IAFzFA,SAAS;EAIX;EAEA,MAAMyC,UAAU,GAAG,MAAMC,YAAY,CACnChC,eAAe,CAACS,KAAK,EACrBQ,YAAY,EACZjB,eAAe,CAACmB,SAAS,EACzBnB,eAAe,CAACqB,YAAY,EAC5BrB,eAAe,CAACsB,aAClB,CAAC;EAEDnC,OAAO,CAAC0C,IAAI,CAAC,sBAAsB7B,eAAe,CAACgB,MAAM,EAAE,CAAC;EAC5D,MAAM5B,EAAE,CAAC6C,SAAS,CAChBjC,eAAe,CAACgB,MAAM,EACtBkB,IAAI,CAACC,SAAS,CACZJ,UAAU,EACV,IAAI,EACJ,CACF,CACF,CAAC;EACD;EACA,IACEA,UAAU,CAACK,UAAU,CAACA,UAAU,CAACZ,MAAM,GAAG,CAAC,IACxCO,UAAU,CAACM,kBAAkB,CAACD,UAAU,CAACZ,MAAM,GAAG,CAAC,EACtD;IACA,MAAMpC,EAAE,CAAC6C,SAAS,CAChBjC,eAAe,CAACoB,gBAAgB,EAChCc,IAAI,CAACC,SAAS,CACZJ,UAAU,CAACK,UAAU,EACrB,IAAI,EACJ,CACF,CACF,CAAC;EACH;AACF;AAEA,eAAeJ,YAAYA,CACzBvB,KAAa,EACbQ,YAAoB,EACpBE,SAA6B,EAC7BmB,cAAkC,EAClChB,aAAsB,EACtB;EACA,MAAMiB,CAAC,GAAG,MAAM9C,cAAc,CAC5BwB,YAAY,EACZ,YAAY,MAAM,MAAM,CAACR,KAAK,CAAC,EAC/BU,SAAS,EACTmB,cAAc,EACdhB,aACF,CAAC;EACD,OAAOiB,CAAC;AACV","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"main.js","names":["consola","fs","path","invariant","yargs","hideBin","defineOntology","apiNamespaceRegex","uuidRegex","main","args","process","argv","commandLineOpts","version","wrap","Math","min","terminalWidth","strict","help","options","input","alias","describe","type","default","coerce","resolve","output","apiNamespace","snapshotDir","outputDir","valueTypesOutput","dependencies","generateCodeSnippets","codeSnippetPackageName","codeSnippetDir","randomnessKey","parseAsync","length","slice","env","NODE_ENV","test","info","undefined","ontologyIr","loadOntology","writeFile","JSON","stringify","valueTypes","importedValueTypes","dependencyFile","snippetPackageName","q"],"sources":["main.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { consola } from \"consola\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\nimport invariant from \"tiny-invariant\";\nimport yargs from \"yargs\";\nimport { hideBin } from \"yargs/helpers\";\nimport { defineOntology } from \"../api/defineOntology.js\";\n\nconst apiNamespaceRegex = /^[a-z0-9-]+(\\.[a-z0-9-]+)*\\.$/;\nconst uuidRegex =\n /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;\n\nexport default async function main(\n args: string[] = process.argv,\n): Promise<void> {\n const commandLineOpts: {\n input: string;\n output: string;\n apiNamespace: string;\n snapshotDir: string;\n valueTypesOutput: string;\n outputDir?: string;\n dependencies?: string;\n generateCodeSnippets: boolean;\n codeSnippetPackageName: string;\n codeSnippetDir: string;\n randomnessKey?: string;\n } = await yargs(hideBin(args))\n .version(process.env.PACKAGE_VERSION ?? \"\")\n .wrap(Math.min(150, yargs().terminalWidth()))\n .strict()\n .help()\n .options({\n input: {\n alias: \"i\",\n describe: \"Input file\",\n type: \"string\",\n default: \".ontology/ontology.ts\",\n coerce: path.resolve,\n },\n output: {\n alias: \"o\",\n describe: \"Output file\",\n type: \"string\",\n default: \"ontology.json\",\n coerce: path.resolve,\n },\n apiNamespace: {\n describe: \"Api name prefix for namespaced ontology types\",\n type: \"string\",\n default: \"\",\n },\n snapshotDir: {\n alias: \"s\",\n describe: \"Snapshot directory\",\n type: \"string\",\n default: \"snapshots\",\n coerce: path.resolve,\n },\n outputDir: {\n alias: \"d\",\n describe: \"Directory for generated ontology entities\",\n type: \"string\",\n coerce: path.resolve,\n },\n valueTypesOutput: {\n describe: \"Value Type Output File\",\n type: \"string\",\n default: \"value-types.json\",\n coerce: path.resolve,\n },\n dependencies: {\n describe: \"File to write dependencies to\",\n type: \"string\",\n coerce: path.resolve,\n },\n generateCodeSnippets: {\n describe: \"Enable code snippet files creation\",\n type: \"boolean\",\n default: false,\n },\n codeSnippetPackageName: {\n describe:\n \"The package name that will be displayed in the code snippets\",\n default: \"\",\n type: \"string\",\n },\n codeSnippetDir: {\n describe: \"Directory for generated code snippet files\",\n type: \"string\",\n default: \"./\",\n coerce: path.resolve,\n },\n randomnessKey: {\n describe: \"Value used to assure uniqueness of entities\",\n type: \"string\",\n coerce: path.resolve,\n },\n })\n .parseAsync();\n let apiNamespace = \"\";\n if (commandLineOpts.apiNamespace.length !== 0) {\n apiNamespace = (commandLineOpts.apiNamespace.slice(-1) !== \".\")\n ? commandLineOpts.apiNamespace + \".\"\n : commandLineOpts.apiNamespace;\n invariant(apiNamespace.length < 1024, \"API namespace is too long.\");\n invariant(\n apiNamespaceRegex.test(apiNamespace),\n \"API namespace is invalid! It is expected to conform to ^[a-z0-9-]+(\\.[a-z0-9-]+)*\\.$\",\n );\n }\n consola.info(`Loading ontology from ${commandLineOpts.input}`);\n\n if (\n !commandLineOpts.generateCodeSnippets\n && (commandLineOpts.codeSnippetPackageName !== \"\"\n || commandLineOpts.codeSnippetDir !== path.resolve(\"./\"))\n ) {\n consola.info(\n \"Package name and/or directory supplied for code snippets, but code snippet generation is false.\",\n );\n }\n\n if (commandLineOpts.randomnessKey !== undefined) {\n invariant(\n uuidRegex.test(commandLineOpts.randomnessKey),\n \"Supplied randomness key is not a uuid and shouldn't be used as a uniqueness guarantee\",\n );\n }\n\n const ontologyIr = await loadOntology(\n commandLineOpts.input,\n apiNamespace,\n commandLineOpts.outputDir,\n commandLineOpts.dependencies,\n commandLineOpts.generateCodeSnippets,\n commandLineOpts.codeSnippetPackageName,\n commandLineOpts.codeSnippetDir,\n commandLineOpts.randomnessKey,\n );\n\n consola.info(`Saving ontology to ${commandLineOpts.output}`);\n await fs.writeFile(\n commandLineOpts.output,\n JSON.stringify(\n ontologyIr,\n null,\n 2,\n ),\n );\n // No point in generating block if there aren't any value types\n if (\n ontologyIr.valueTypes.valueTypes.length > 0\n || ontologyIr.importedValueTypes.valueTypes.length > 0\n ) {\n await fs.writeFile(\n commandLineOpts.valueTypesOutput,\n JSON.stringify(\n ontologyIr.valueTypes,\n null,\n 2,\n ),\n );\n }\n}\n\nasync function loadOntology(\n input: string,\n apiNamespace: string,\n outputDir: string | undefined,\n dependencyFile: string | undefined,\n generateCodeSnippets: boolean,\n snippetPackageName: string,\n codeSnippetDir: string,\n randomnessKey?: string,\n) {\n const q = await defineOntology(\n apiNamespace,\n async () => await import(input),\n outputDir,\n dependencyFile,\n generateCodeSnippets,\n snippetPackageName,\n codeSnippetDir,\n randomnessKey,\n );\n return q;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,OAAO,QAAQ,SAAS;AACjC,OAAO,KAAKC,EAAE,MAAM,kBAAkB;AACtC,OAAO,KAAKC,IAAI,MAAM,WAAW;AACjC,OAAOC,SAAS,MAAM,gBAAgB;AACtC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,OAAO,QAAQ,eAAe;AACvC,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,MAAMC,iBAAiB,GAAG,+BAA+B;AACzD,MAAMC,SAAS,GACb,gEAAgE;AAElE,eAAe,eAAeC,IAAIA,CAChCC,IAAc,GAAGC,OAAO,CAACC,IAAI,EACd;EACf,MAAMC,eAYL,GAAG,MAAMT,KAAK,CAACC,OAAO,CAACK,IAAI,CAAC,CAAC,CAC3BI,OAAO,CAAC,mBAA+B,EAAE,CAAC,CAC1CC,IAAI,CAACC,IAAI,CAACC,GAAG,CAAC,GAAG,EAAEb,KAAK,CAAC,CAAC,CAACc,aAAa,CAAC,CAAC,CAAC,CAAC,CAC5CC,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,OAAO,CAAC;IACPC,KAAK,EAAE;MACLC,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,YAAY;MACtBC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,uBAAuB;MAChCC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDC,MAAM,EAAE;MACNN,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,aAAa;MACvBC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,eAAe;MACxBC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDE,YAAY,EAAE;MACZN,QAAQ,EAAE,+CAA+C;MACzDC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE;IACX,CAAC;IACDK,WAAW,EAAE;MACXR,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,oBAAoB;MAC9BC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,WAAW;MACpBC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDI,SAAS,EAAE;MACTT,KAAK,EAAE,GAAG;MACVC,QAAQ,EAAE,2CAA2C;MACrDC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDK,gBAAgB,EAAE;MAChBT,QAAQ,EAAE,wBAAwB;MAClCC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,kBAAkB;MAC3BC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDM,YAAY,EAAE;MACZV,QAAQ,EAAE,+BAA+B;MACzCC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDO,oBAAoB,EAAE;MACpBX,QAAQ,EAAE,oCAAoC;MAC9CC,IAAI,EAAE,SAAS;MACfC,OAAO,EAAE;IACX,CAAC;IACDU,sBAAsB,EAAE;MACtBZ,QAAQ,EACN,8DAA8D;MAChEE,OAAO,EAAE,EAAE;MACXD,IAAI,EAAE;IACR,CAAC;IACDY,cAAc,EAAE;MACdb,QAAQ,EAAE,4CAA4C;MACtDC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,IAAI;MACbC,MAAM,EAAEzB,IAAI,CAAC0B;IACf,CAAC;IACDU,aAAa,EAAE;MACbd,QAAQ,EAAE,6CAA6C;MACvDC,IAAI,EAAE,QAAQ;MACdE,MAAM,EAAEzB,IAAI,CAAC0B;IACf;EACF,CAAC,CAAC,CACDW,UAAU,CAAC,CAAC;EACf,IAAIT,YAAY,GAAG,EAAE;EACrB,IAAIjB,eAAe,CAACiB,YAAY,CAACU,MAAM,KAAK,CAAC,EAAE;IAC7CV,YAAY,GAAIjB,eAAe,CAACiB,YAAY,CAACW,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,GAC1D5B,eAAe,CAACiB,YAAY,GAAG,GAAG,GAClCjB,eAAe,CAACiB,YAAY;IAChC,EAAUA,YAAY,CAACU,MAAM,GAAG,IAAI,IAAA7B,OAAA,CAAA+B,GAAA,CAAAC,QAAA,oBAApCxC,SAAS,QAA6B,4BAA4B,IAAlEA,SAAS;IACT,CACEI,iBAAiB,CAACqC,IAAI,CAACd,YAAY,CAAC,GAAAnB,OAAA,CAAA+B,GAAA,CAAAC,QAAA,oBADtCxC,SAAS,QAEP,sFAAsF,IAFxFA,SAAS;EAIX;EACAH,OAAO,CAAC6C,IAAI,CAAC,yBAAyBhC,eAAe,CAACS,KAAK,EAAE,CAAC;EAE9D,IACE,CAACT,eAAe,CAACsB,oBAAoB,KACjCtB,eAAe,CAACuB,sBAAsB,KAAK,EAAE,IAC5CvB,eAAe,CAACwB,cAAc,KAAKnC,IAAI,CAAC0B,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3D;IACA5B,OAAO,CAAC6C,IAAI,CACV,iGACF,CAAC;EACH;EAEA,IAAIhC,eAAe,CAACyB,aAAa,KAAKQ,SAAS,EAAE;IAC/C,CACEtC,SAAS,CAACoC,IAAI,CAAC/B,eAAe,CAACyB,aAAa,CAAC,GAAA3B,OAAA,CAAA+B,GAAA,CAAAC,QAAA,oBAD/CxC,SAAS,QAEP,uFAAuF,IAFzFA,SAAS;EAIX;EAEA,MAAM4C,UAAU,GAAG,MAAMC,YAAY,CACnCnC,eAAe,CAACS,KAAK,EACrBQ,YAAY,EACZjB,eAAe,CAACmB,SAAS,EACzBnB,eAAe,CAACqB,YAAY,EAC5BrB,eAAe,CAACsB,oBAAoB,EACpCtB,eAAe,CAACuB,sBAAsB,EACtCvB,eAAe,CAACwB,cAAc,EAC9BxB,eAAe,CAACyB,aAClB,CAAC;EAEDtC,OAAO,CAAC6C,IAAI,CAAC,sBAAsBhC,eAAe,CAACgB,MAAM,EAAE,CAAC;EAC5D,MAAM5B,EAAE,CAACgD,SAAS,CAChBpC,eAAe,CAACgB,MAAM,EACtBqB,IAAI,CAACC,SAAS,CACZJ,UAAU,EACV,IAAI,EACJ,CACF,CACF,CAAC;EACD;EACA,IACEA,UAAU,CAACK,UAAU,CAACA,UAAU,CAACZ,MAAM,GAAG,CAAC,IACxCO,UAAU,CAACM,kBAAkB,CAACD,UAAU,CAACZ,MAAM,GAAG,CAAC,EACtD;IACA,MAAMvC,EAAE,CAACgD,SAAS,CAChBpC,eAAe,CAACoB,gBAAgB,EAChCiB,IAAI,CAACC,SAAS,CACZJ,UAAU,CAACK,UAAU,EACrB,IAAI,EACJ,CACF,CACF,CAAC;EACH;AACF;AAEA,eAAeJ,YAAYA,CACzB1B,KAAa,EACbQ,YAAoB,EACpBE,SAA6B,EAC7BsB,cAAkC,EAClCnB,oBAA6B,EAC7BoB,kBAA0B,EAC1BlB,cAAsB,EACtBC,aAAsB,EACtB;EACA,MAAMkB,CAAC,GAAG,MAAMlD,cAAc,CAC5BwB,YAAY,EACZ,YAAY,MAAM,MAAM,CAACR,KAAK,CAAC,EAC/BU,SAAS,EACTsB,cAAc,EACdnB,oBAAoB,EACpBoB,kBAAkB,EAClBlB,cAAc,EACdC,aACF,CAAC;EACD,OAAOkB,CAAC;AACV","ignoreList":[]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAsBA,cAAc,0BAA0B,iCAAkC;AAU1E,OAAO,iBAAS,mBACdA,UAAU,oBACVC,iCACAC","names":["ontology: OntologyDefinition","packageName: string | undefined","outputDir: string | undefined"],"sources":["../../../../src/api/code-snippets/createCodeSnippets.ts"],"version":3,"file":"createCodeSnippets.d.ts"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export declare enum interfaceSnippets {
|
|
2
|
+
loadInterfacesReference = 0,
|
|
3
|
+
loadAllInterfacesReference = 1,
|
|
4
|
+
loadOrderedInterfacesReference = 2,
|
|
5
|
+
searchInterfacesReference = 3,
|
|
6
|
+
loadInterfaceMetadataSnippet = 4,
|
|
7
|
+
subscribeToObjectSetInstructions = 5
|
|
8
|
+
}
|
|
9
|
+
export declare enum actionSnippets {
|
|
10
|
+
applyAction = 0,
|
|
11
|
+
batchApplyAction = 1
|
|
12
|
+
}
|
|
13
|
+
export declare enum objectSnippets {
|
|
14
|
+
loadSingleObjectGuide = 0,
|
|
15
|
+
loadObjectsReference = 1,
|
|
16
|
+
loadAllObjectsReference = 2,
|
|
17
|
+
loadOrderedInterfacesReference = 3,
|
|
18
|
+
searchObjectsGuide = 4,
|
|
19
|
+
aggregationTemplate = 5,
|
|
20
|
+
objectSetOperationsGuide = 6,
|
|
21
|
+
loadObjectMetadataSnippet = 7,
|
|
22
|
+
subscribeToObjectSetInstructions = 8
|
|
23
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,oBAAY,kBAAkB;CAC5B;CACA;CACA;CACA;CACA;CACA;AACD;AAED,oBAAY,eAAe;CACzB;CACA;AACD;AAED,oBAAY,eAAe;CACzB;CACA;CACA;CACA;CACA;CACA;CAWA;CAMA;CACA;AACD","names":[],"sources":["../../../../src/api/code-snippets/snippetTypes.ts"],"version":3,"file":"snippetTypes.d.ts"}
|
|
@@ -4,7 +4,7 @@ import type { ActionParameterAllowedValues } from "./action/ActionParameterAllow
|
|
|
4
4
|
import type { ActionType } from "./action/ActionType.js";
|
|
5
5
|
import type { OntologyEntityType } from "./common/OntologyEntityTypeMapping.js";
|
|
6
6
|
export declare function updateOntology<T extends OntologyEntityType>(entity: T): void;
|
|
7
|
-
export declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string, randomnessKey?: string): Promise<OntologyIr>;
|
|
7
|
+
export declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string, codeSnippetFiles?: boolean, snippetPackageName?: string, snippetFileOutputDir?: string, randomnessKey?: string): Promise<OntologyIr>;
|
|
8
8
|
export declare function writeStaticObjects(outputDir: string): void;
|
|
9
9
|
export declare function buildDatasource(apiName: string, definition: OntologyIrObjectTypeDatasourceDefinition, classificationMarkingGroupName?: string, mandatoryMarkingGroupName?: string): OntologyIrObjectTypeDatasource;
|
|
10
10
|
export declare function cleanAndValidateLinkTypeId(apiName: string): string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cAEE,YACA,iCACA,kCACA,gCACA,0CAGA,8BAEA,2BAEK,uBAAwB;AAS/B,cAAc,uBAAuB,6BAA8B;AACnE,cAAc,oCAAoC,0CAA2C;AAC7F,cAAc,kBAAkB,wBAAyB;
|
|
1
|
+
{"mappings":"AAgBA,cAEE,YACA,iCACA,kCACA,gCACA,0CAGA,8BAEA,2BAEK,uBAAwB;AAS/B,cAAc,uBAAuB,6BAA8B;AACnE,cAAc,oCAAoC,0CAA2C;AAC7F,cAAc,kBAAkB,wBAAyB;AAIzD,cAAc,0BAA0B,uCAAwC;AAiBhF,OAAO,iBAAS,eACd,UAAU,oBAEVA,QAAQ;AAiBV,OAAO,iBAAe,eACpBC,YACAC,mBAAmB,eACnBC,+BACAC,yBACAC,4BACAC,6BACAC,+BACAC,yBACC,QAAQ;AA8CX,OAAO,iBAAS,mBAAmBC;AAgFnC,OAAO,iBAAS,gBACdC,iBACAC,YAAY,0CACZC,yCACAC,qCACC;AA6BH,OAAO,iBAAS,2BAA2BH;AAkB3C,OAAO,iBAAS,4BAA4B;AAI5C,OAAO,iBAAS,yBAAyB;AAIzC,OAAO,iBAAS,oBAAoBI;AAoCpC,OAAO,iBAAS,cACdC,QAAQ,aACP;AAwEH,OAAO,iBAAS,qBACdC,eAAe,+BACd;AAoGH,OAAO,iBAAS,uBACdC,WAAW,kBACV;AAgEH,OAAO,iBAAS,iBAAiBP;AAIjC,OAAO,iBAAS,iBAAiBA;AA8CjC,OAAO,iBAAS,mBAAmBA","names":["entity: T","ns: string","body: () => void | Promise<void>","outputDir: string | undefined","dependencyFile?: string","codeSnippetFiles?: boolean","snippetPackageName?: string","snippetFileOutputDir?: string","randomnessKey?: string","outputDir: string","apiName: string","definition: OntologyIrObjectTypeDatasourceDefinition","classificationMarkingGroupName?: string","mandatoryMarkingGroupName?: string","status: any","action: ActionType","allowedValues: ActionParameterAllowedValues","parameter: ActionParameter"],"sources":["../../../src/api/defineOntology.ts"],"version":3,"file":"defineOntology.d.ts"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/maker",
|
|
3
|
-
"version": "0.14.0-beta.
|
|
3
|
+
"version": "0.14.0-beta.9",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -33,14 +33,15 @@
|
|
|
33
33
|
"tiny-invariant": "^1.3.3",
|
|
34
34
|
"ts-node": "^10.9.2",
|
|
35
35
|
"yargs": "^17.7.2",
|
|
36
|
-
"@osdk/api": "~2.6.0-beta.
|
|
36
|
+
"@osdk/api": "~2.6.0-beta.5"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
+
"@osdk/typescript-sdk-docs": "^0.2.0",
|
|
39
40
|
"@types/node": "^20.19.13",
|
|
40
41
|
"@types/yargs": "^17.0.33",
|
|
41
42
|
"typescript": "~5.5.4",
|
|
42
43
|
"vitest": "^3.2.4",
|
|
43
|
-
"@osdk/client.unstable": "~2.6.0-beta.
|
|
44
|
+
"@osdk/client.unstable": "~2.6.0-beta.5",
|
|
44
45
|
"@osdk/monorepo.api-extractor": "~0.5.0-beta.1",
|
|
45
46
|
"@osdk/monorepo.tsconfig": "~0.5.0-beta.1"
|
|
46
47
|
},
|