Reorg examples extra. Fixes #476 (#485)

.changeset/pre.json

@@ -2,11 +2,11 @@
   "mode": "pre",
   "tag": "beta",
   "initialVersions": {
-    "@osdk/examples.basic.cli": "0.0.0",
-    "@osdk/examples.basic.sdk": "0.0.0",
+    "@osdk/e2e.sandbox.catchall": "0.0.0",
+    "@osdk/e2e.generated.catchall": "0.0.0",
     "@osdk/examples.docs.example": "0.0.1",
-    "@osdk/examples.one.dot.one": "0.0.17",
-    "@osdk/examples.todoapp": "0.0.10",
+    "@osdk/e2e.generated.1.1.x": "0.0.17",
+    "@osdk/e2e.sandbox.todoappapp": "0.0.10",
     "@osdk/examples.next-static-export": "0.0.0",
     "@osdk/examples.react": "0.0.0",
     "@osdk/examples.tutorial-todo-app": "0.0.0",

.changeset/weak-dragons-wonder.md

@@ -0,0 +1,2 @@
+---
+---

.lintstagedrc.mjs

@@ -15,12 +15,16 @@ export default {
   "packages/monorepo.*/**/*.{js,jsx,ts,tsx,mjs,cjs}": [
     "dprint fmt",
   ],
-  "{packages,examples-extra/basic}/**/*.{js,jsx,ts,tsx,mjs,cjs}": (
+  "packages/**/*.{js,jsx,ts,tsx,mjs,cjs}": (
     files,
   ) => {
     const match = micromatch.not(
       files,
-      ["**/templates/**/*", "**/generatedNoCheck/**/*"],
+      [
+        "**/templates/**/*",
+        "**/generatedNoCheck/**/*",
+        "**/generatedNoCheck2/**/*",
+      ],
     );
     if (match.length === 0) return [];
     return [

.monorepolint.config.mjs

@@ -36,6 +36,8 @@ const nonStandardPackages = [
   "@osdk/examples.*",
   "@osdk/foundry-sdk-generator",
   "@osdk/monorepo.*",
+  "@osdk/e2e.sandbox.*", // sandboxes for manual e2e testing
+  "@osdk/e2e.generated.*", // generated sdks for e2e testing
   "@osdk/shared.client",
   "@osdk/tests.*",
 ];
@@ -442,19 +444,22 @@ export default {
     ),
 
     ...standardPackageRules({
-      includePackages: ["@osdk/examples.basic.**"],
-      excludePackages: ["@osdk/examples.one.dot.one"],
+      includePackages: [
+        "@osdk/e2e.generated.catchall",
+        "@osdk/e2e.sandbox.catchall",
+      ],
+      excludePackages: ["@osdk/e2e.generated.1.1.x"],
     }, {
       esmOnly: true,
       legacy: false,
-      packageDepth: 3,
+      packageDepth: 2,
       type: "example",
     }),
 
     // most packages can use the newest typescript, but we enforce that @osdk/example.one.dot.one uses TS4.9
     // so that we get build-time checking to make sure we don't regress v1.1 clients using an older Typescript.
     ...standardPackageRules({
-      includePackages: ["@osdk/examples.one.dot.one"],
+      includePackages: ["@osdk/e2e.generated.1.1.x"],
     }, {
       legacy: false,
       packageDepth: 2,

eslint.config.mjs

@@ -106,6 +106,7 @@ export default tseslint.config(
       "**/bin/*.mjs",
       "**/bin/*.cjs",
       "examples-extra/**/*",
+      "packages/e2e.sandbox.*/**/*",
     ],
     rules: {
       "header/header": "off",
@@ -120,6 +121,7 @@ export default tseslint.config(
       "**/*.test.ts",
       "**/test/*",
       "examples-extra/**/*",
+      "packages/e2e.sandbox.*/**/*",
     ],
     rules: {
       "no-console": "off",

examples/example-next-static-export/package.json

@@ -14,7 +14,7 @@
     "start": "next start"
   },
   "dependencies": {
-    "@osdk/examples.one.dot.one": "workspace:*",
+    "@osdk/e2e.generated.1.1.x": "workspace:*",
     "next": "14.2.3",
     "react": "^18",
     "react-dom": "^18"

examples/example-next-static-export/src/app/page.tsx

@@ -15,7 +15,7 @@ function Home() {
 
   return (
     <div>
-      <h1>@osdk/examples.one.dot.one</h1>
+      <h1>@osdk/e2e.generated.1.1.x</h1>
       <p>
         Welcome to your Ontology SDK! Try using any of the following methods
         now.

examples/example-next-static-export/src/lib/client.ts

@@ -1,4 +1,4 @@
-import { FoundryClient, PublicClientAuth } from "@osdk/examples.one.dot.one";
+import { FoundryClient, PublicClientAuth } from "@osdk/e2e.generated.1.1.x";
 
 const url = process.env.NEXT_PUBLIC_FOUNDRY_API_URL;
 const clientId = process.env.NEXT_PUBLIC_FOUNDRY_CLIENT_ID;

examples/example-react/package.json

@@ -14,7 +14,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@osdk/examples.one.dot.one": "workspace:*",
+    "@osdk/e2e.generated.1.1.x": "workspace:*",
     "react": "^18",
     "react-dom": "^18",
     "react-router-dom": "^6.23.1"

examples/example-react/src/Home.tsx

@@ -9,7 +9,7 @@ function Home() {
 
   return (
     <Layout>
-      <h1>@osdk/examples.one.dot.one</h1>
+      <h1>@osdk/e2e.generated.1.1.x</h1>
       <p>
         Welcome to your Ontology SDK! Try using any of the following methods
         now.

examples/example-react/src/client.ts

@@ -1,4 +1,4 @@
-import { FoundryClient, PublicClientAuth } from "@osdk/examples.one.dot.one";
+import { FoundryClient, PublicClientAuth } from "@osdk/e2e.generated.1.1.x";
 
 const url = import.meta.env.VITE_FOUNDRY_API_URL;
 const clientId = import.meta.env.VITE_FOUNDRY_CLIENT_ID;

examples/example-tutorial-todo-aip-app/package.json

@@ -14,7 +14,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@osdk/examples.one.dot.one": "workspace:*",
+    "@osdk/e2e.generated.1.1.x": "workspace:*",
     "react": "^18",
     "react-dom": "^18",
     "react-router-dom": "^6.23.1",

examples/example-tutorial-todo-aip-app/src/client.ts

@@ -1,4 +1,4 @@
-import { FoundryClient, PublicClientAuth } from "@osdk/examples.one.dot.one";
+import { FoundryClient, PublicClientAuth } from "@osdk/e2e.generated.1.1.x";
 
 const url = import.meta.env.VITE_FOUNDRY_API_URL;
 const clientId = import.meta.env.VITE_FOUNDRY_CLIENT_ID;

examples/example-tutorial-todo-app/package.json

@@ -14,7 +14,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@osdk/examples.one.dot.one": "workspace:*",
+    "@osdk/e2e.generated.1.1.x": "workspace:*",
     "react": "^18",
     "react-dom": "^18",
     "react-router-dom": "^6.23.1",

examples/example-tutorial-todo-app/src/client.ts

@@ -1,4 +1,4 @@
-import { FoundryClient, PublicClientAuth } from "@osdk/examples.one.dot.one";
+import { FoundryClient, PublicClientAuth } from "@osdk/e2e.generated.1.1.x";
 
 const url = import.meta.env.VITE_FOUNDRY_API_URL;
 const clientId = import.meta.env.VITE_FOUNDRY_CLIENT_ID;

examples/example-vue/package.json

@@ -13,7 +13,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@osdk/examples.one.dot.one": "workspace:*",
+    "@osdk/e2e.generated.1.1.x": "workspace:*",
     "vue": "^3.4.27",
     "vue-router": "^4.2.5"
   },

examples/example-vue/src/Home.vue

@@ -7,7 +7,7 @@ const queryApiNames = Object.keys(client.ontology.queries);
 </script>
 
 <template>
-  <h1>@osdk/examples.one.dot.one</h1>
+  <h1>@osdk/e2e.generated.1.1.x</h1>
   <p>
     Welcome to your Ontology SDK! Try using any of the following methods now.
   </p>

examples/example-vue/src/client.ts

@@ -1,4 +1,4 @@
-import { FoundryClient, PublicClientAuth } from "@osdk/examples.one.dot.one";
+import { FoundryClient, PublicClientAuth } from "@osdk/e2e.generated.1.1.x";
 
 const url = import.meta.env.VITE_FOUNDRY_API_URL;
 const clientId = import.meta.env.VITE_FOUNDRY_CLIENT_ID;

examples-extra/one_dot_one/CHANGELOG.md → packages/e2e.generated.1.1.x/CHANGELOG.md

@@ -1,4 +1,4 @@
-# @osdk/examples.one.dot.one
+# @osdk/e2e.generated.1.1.x
 
 ## 0.0.17
 

examples-extra/one_dot_one/package.json → packages/e2e.generated.1.1.x/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@osdk/examples.one.dot.one",
+  "name": "@osdk/e2e.generated.1.1.x",
   "private": true,
   "version": "0.0.17",
   "description": "",

examples-extra/basic/sdk/package.json → packages/e2e.generated.catchall/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@osdk/examples.basic.sdk",
+  "name": "@osdk/e2e.generated.catchall",
   "private": true,
   "version": "0.0.0",
   "description": "",
@@ -19,14 +19,14 @@
     }
   },
   "scripts": {
-    "check-attw": "../../../scripts/build_common/check-attw.sh esm",
+    "check-attw": "../../scripts/build_common/check-attw.sh esm",
     "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
     "codegen": "rm -rf src/generatedNoCheck/* && osdk-unstable-typescript generate --outDir src/generatedNoCheck --ontologyPath ontology.json --beta true --packageType module --version dev --internal",
     "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
     "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
     "transpile": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.js' -or -name '*.js.map' -or -name '*.cjs' -or -name '*.cjs.map' \\) -delete && tsup",
     "transpileWatch": "tsup --watch",
-    "typecheck": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.ts' -or -name '*.ts.map' -or -name '*.cts' -or -name '*.cts.map' \\) -delete && ../../../scripts/build_common/typecheck.sh esm"
+    "typecheck": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.ts' -or -name '*.ts.map' -or -name '*.cts' -or -name '*.cts.map' \\) -delete && ../../scripts/build_common/typecheck.sh esm"
   },
   "dependencies": {
     "@osdk/api": "workspace:~",

packages/e2e.generated.catchall/src/generatedNoCheck/ontology/queries/getTodoCount.ts

@@ -0,0 +1,9 @@
+import { QueryDefinition } from '@osdk/api';
+
+export const getTodoCount = {
+  apiName: 'getTodoCount',
+  type: 'query',
+  version: '0.1.2',
+  parameters: {},
+  output: { nullable: false, type: 'integer' },
+} satisfies QueryDefinition<'getTodoCount', never>;

packages/e2e.generated.catchall/src/generatedNoCheck/ontology/queries/index.ts

@@ -0,0 +1,2 @@
+export * from './getTodoCount.js';
+export * from './queryTakesAllParameterTypes.js';

packages/e2e.generated.catchall/src/generatedNoCheck/ontology/queries/queryTakesAllParameterTypes.ts

@@ -0,0 +1,111 @@
+import { QueryDefinition } from '@osdk/api';
+import { Todo } from '../objects.js';
+export const queryTakesAllParameterTypes = {
+  apiName: 'queryTakesAllParameterTypes',
+  description: 'description of the query that takes all parameter types',
+  displayName: 'qTAPT',
+  type: 'query',
+  version: 'version',
+  parameters: {
+    double: { description: 'a double parameter', nullable: false, type: 'double' },
+    float: { nullable: false, type: 'float' },
+    integer: { nullable: false, type: 'integer' },
+    long: { nullable: false, type: 'long' },
+    attachment: { nullable: false, type: 'attachment' },
+    boolean: { nullable: false, type: 'boolean' },
+    date: { nullable: false, type: 'date' },
+    string: { nullable: false, type: 'string' },
+    timestamp: { nullable: false, type: 'timestamp' },
+    object: {
+      nullable: false,
+      object: 'Todo',
+      type: 'object',
+
+      __OsdkTargetType: Todo,
+    },
+    objectSet: {
+      nullable: false,
+      objectSet: 'Todo',
+      type: 'objectSet',
+
+      __OsdkTargetType: Todo,
+    },
+    array: { description: 'an array of strings', multiplicity: true, nullable: false, type: 'string' },
+    set: {
+      description: 'a set of strings',
+      nullable: false,
+      set: {
+        type: 'string',
+        nullable: false,
+      },
+      type: 'set',
+    },
+    unionNonNullable: {
+      description: 'a union of strings and integers',
+      nullable: false,
+      type: 'union',
+      union: [
+        {
+          type: 'string',
+          nullable: false,
+        },
+        {
+          type: 'integer',
+          nullable: false,
+        },
+      ],
+    },
+    unionNullable: {
+      description: 'a union of strings and integers but its optional',
+      nullable: true,
+      type: 'union',
+      union: [
+        {
+          type: 'string',
+          nullable: false,
+        },
+        {
+          type: 'integer',
+          nullable: false,
+        },
+      ],
+    },
+    struct: {
+      description: 'a struct with some fields',
+      nullable: false,
+      struct: {
+        name: {
+          type: 'string',
+          nullable: false,
+        },
+        id: {
+          type: 'integer',
+          nullable: false,
+        },
+      },
+      type: 'struct',
+    },
+    twoDimensionalAggregation: {
+      nullable: false,
+      twoDimensionalAggregation: {
+        keyType: 'string',
+        valueType: 'double',
+      },
+      type: 'twoDimensionalAggregation',
+    },
+    threeDimensionalAggregation: {
+      nullable: false,
+      threeDimensionalAggregation: {
+        keyType: 'range',
+        keySubtype: 'date',
+        valueType: {
+          keyType: 'range',
+          keySubtype: 'timestamp',
+          valueType: 'date',
+        },
+      },
+      type: 'threeDimensionalAggregation',
+    },
+  },
+  output: { nullable: false, type: 'string' },
+} satisfies QueryDefinition<'queryTakesAllParameterTypes', 'Todo'>;

examples-extra/basic/cli/package.json → packages/e2e.sandbox.catchall/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@osdk/examples.basic.cli",
+  "name": "@osdk/e2e.sandbox.catchall",
   "private": true,
   "version": "0.0.0",
   "license": "Apache-2.0",
@@ -18,19 +18,19 @@
     }
   },
   "scripts": {
-    "check-attw": "../../../scripts/build_common/check-attw.sh esm",
+    "check-attw": "../../scripts/build_common/check-attw.sh esm",
     "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
     "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
     "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
     "transpile": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.js' -or -name '*.js.map' -or -name '*.cjs' -or -name '*.cjs.map' \\) -delete && tsup",
     "transpileWatch": "tsup --watch",
-    "typecheck": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.ts' -or -name '*.ts.map' -or -name '*.cts' -or -name '*.cts.map' \\) -delete && ../../../scripts/build_common/typecheck.sh esm"
+    "typecheck": "find . \\( -path build/cjs -or -path build/esm -or -path build/browser \\) -type f \\( -name '*.ts' -or -name '*.ts.map' -or -name '*.cts' -or -name '*.cts.map' \\) -delete && ../../scripts/build_common/typecheck.sh esm"
   },
   "dependencies": {
     "@osdk/api": "workspace:~",
     "@osdk/client": "workspace:~",
     "@osdk/client.api": "workspace:*",
-    "@osdk/examples.basic.sdk": "workspace:~",
+    "@osdk/e2e.generated.catchall": "workspace:~",
     "@osdk/foundry": "workspace:~",
     "@osdk/internal.foundry": "workspace:~",
     "chalk": "^5.3.0",