Merge branch 'main' into ssanjay/timeseries

.changeset/new-points-sing.md

@@ -0,0 +1,5 @@
+---
+"@osdk/client": patch
+---
+
+Fix action params that take objects to correctly parse out primary key.

.changeset/odd-hornets-protect.md

@@ -0,0 +1,5 @@
+---
+"@osdk/legacy-client": patch
+---
+
+Oauth errors should include a cause now on supported platforms

.changeset/pre.json

@@ -59,6 +59,7 @@
   },
   "changesets": [
     "calm-pillows-collect",
+    "chilly-mayflies-vanish",
     "chilly-melons-hammer",
     "chilly-singers-compare",
     "cool-rice-check",
@@ -71,23 +72,29 @@
     "four-ways-add",
     "great-geese-fail",
     "green-chefs-speak",
+    "healthy-nails-relax",
     "itchy-radios-own",
     "khaki-plants-sort",
     "large-ads-listen",
+    "lazy-jobs-attend",
     "lovely-mice-beg",
     "moody-bats-hear",
     "moody-crews-ring",
     "nervous-parrots-admire",
     "nervous-pets-return",
     "ninety-avocados-unite",
+    "old-kiwis-marry",
+    "orange-icons-battle",
     "pink-insects-itch",
     "plenty-peaches-scream",
     "pretty-cherries-hunt",
     "pretty-dingos-smash",
     "purple-cameras-invite",
+    "purple-pots-fold",
     "purple-trainers-laugh",
     "rotten-lamps-protect",
     "rotten-shirts-cross",
+    "serious-camels-rest",
     "serious-glasses-try",
     "sharp-penguins-double",
     "shy-cougars-remain",
@@ -99,6 +106,7 @@
     "tough-hats-push",
     "unlucky-moose-lay",
     "unlucky-wombats-switch",
-    "wild-plums-yell"
+    "wild-plums-yell",
+    "young-fireants-repair"
   ]
 }

.gitignore

@@ -31,3 +31,6 @@ packages/legacy-client/src/generatedNoCheck
 .log
 pnpm-publish-summary.json
 .npmrc
+
+api-docs/
+temp/

.monorepolint.config.mjs

@@ -34,6 +34,7 @@ const DELETE_SCRIPT_ENTRY = { options: [undefined], fixValue: undefined };
 const nonStandardPackages = [
   "mytsup",
   "tsconfig",
+  "@osdk/api-extractor",
   "@osdk/examples.todoapp",
   "@osdk/tests.*",
   "@osdk/foundry-sdk-generator",
@@ -215,7 +216,6 @@ function standardPackageRules(shared, options) {
       ...shared,
       options: {
         scripts: {
-          "dev:transpile": DELETE_SCRIPT_ENTRY,
           clean: "rm -rf lib dist types build tsconfig.tsbuildinfo",
           "check-attw":
             `${pathToWorkspaceRoot}/scripts/build_common/check-attw.sh ${
@@ -224,10 +224,10 @@ function standardPackageRules(shared, options) {
           lint: "eslint . && dprint check  --config $(find-up dprint.json)",
           "fix-lint":
             "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
-          prettier: DELETE_SCRIPT_ENTRY,
-          transpile: "tsup",
+          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",
           typecheck:
-            `${pathToWorkspaceRoot}/scripts/build_common/typecheck.sh ${
+            `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 && ${pathToWorkspaceRoot}/scripts/build_common/typecheck.sh ${
               options.esmOnly ? "esm" : "both"
             }`,
         },

.vscode/settings.json

@@ -5,7 +5,7 @@
     "editor.defaultFormatter": "dprint.dprint"
   },
   "[typescript]": {
-    "editor.defaultFormatter": "vscode.typescript-language-features"
+    "editor.defaultFormatter": "dprint.dprint"
   },
   "[json]": {
     "editor.defaultFormatter": "dprint.dprint"

README.md

@@ -14,13 +14,13 @@
    > **Follow semver rules here.**
    1. Assuming you've run `pnpm install`, run `changeset` (or `pnpm exec changeset`).
    2. The tool will split things into changed vs unchanged packages (which you may need if you decide to add changeset logs in a future PR for past features)
-   3. Select the packages you want the changeset applied to using the arrow keys (up/down) and spacebar to "select" the package.
+   3. Select the packages you want the changeset applied to using the arrow keys (up/down) and space-bar to "select" the package.
    4. Press enter to continue.
-   5. The CLI will go through a progression of asking you which pacakges you previously selected need a major bump? Then a minor bump? Patch bumps assumed for remaining packages changed. Arrows and space bar to select. Enter to continue (even if you selected nothing).
+   5. The CLI will go through a progression of asking you which packages you previously selected need a major bump? Then a minor bump? Patch bumps assumed for remaining packages changed. Arrows and space bar to select. Enter to continue (even if you selected nothing).
    6. Enter a change (or press enter on empty to open your editor.)
 
    > Info
    >
-   > Full docs on the `changesets` tool can be found at the [changesets/changests github repo](https://github.com/changesets/changesets).
+   > Full docs on the `changesets` tool can be found at the [changesets/changesets github repo](https://github.com/changesets/changesets).
 7. If you're curious what the final build output might look like you can run `pnpm build` from root.
 8. Run all lint rules and tests with `pnpm check` from root.

dev-docs/README.md

@@ -0,0 +1,3 @@
+# Developer Docs for Contributing to osdk-ts
+
+If you are looking for documentation on how to use the OSDK, see your developer console on your foundry stack.

dev-docs/build-notes.md

@@ -0,0 +1,14 @@
+# Build / CI notes for the repo
+
+## api-extractor
+
+Currently, this runs only as part of `@osdk/client.api`, however the goal is to extend this to the entire repo assuming we are satisfied with its output.
+
+While the api-extract can be used for generating rolled up `.d.ts` files, we do not use it for that purpose. Our intention is to use it generate the api report and api documentation. The logic behind the api report is it should make it easier to review the impact of changes to types within the codebase. For example, it can show that we have implicitly created a dependency on a third party library for our own types.
+
+### CI implications
+
+The `api-extractor` has a "local" and a non-local (CI) mode. In the "local" mode, it will automatically update the file we commit for the api report. The intent of the tool is to error in CI if the file that is committed doesn't match the output, however the behavior of the tool is to exit with a non-zero code when there are warnings in the non-local mode. This makes adoption of the tool expensive at best and at worst removes the ability to have granular information.
+
+As such, we run the tool in CI in "local" mode so that we do not get non-zero exits for warnings. Our existing build infrastructure already fails the build if any changes happen to committed files during CI and as such we can rely on that mechanism to be sure that developers have updated the api report that gets committed.
+

dprint.json

@@ -19,7 +19,9 @@
     ".vscode/settings.json",
     "examples/",
     "examples-extra/**/dist",
-    "**/tsup.config.bundled_*"
+    "**/tsup.config.bundled_*",
+    "**/api-docs/",
+    "**/*.report.api.md"
   ],
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.90.4.wasm",

examples-extra/basic/cli/package.json

@@ -22,9 +22,9 @@
     "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": "tsup",
+    "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": "../../../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:~",

examples-extra/basic/sdk/package.json

@@ -24,9 +24,9 @@
     "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": "tsup",
+    "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": "../../../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:~",

examples-extra/basic/sdk/turbo.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "codegen": {
+      "inputs": ["ontology.json"],
+      "outputs": ["src/generatedNoCheck/**/*"],
+      "dependsOn": ["@osdk/cli.cmd.typescript#transpile"]
+    }
+  }
+}

examples-extra/docs_example/package.json

@@ -9,7 +9,7 @@
   },
   "scripts": {
     "build": "tsc && vite build",
-    "codegen": "rm -rf src/generatedNoCheck2/* && rm -rf src/generatedNoCheck/* && osdk-unstable-typescript generate --outDir src/generatedNoCheck --beta true --ontologyPath ontology.json --version dev --internal",
+    "codegen": "rm -rf src/generatedNoCheck/* && osdk-unstable-typescript generate --outDir src/generatedNoCheck --beta true --ontologyPath ontology.json --version dev --internal",
     "dev": "vite",
     "lint": "ESLINT_USE_FLAT_CONFIG=false eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview"

examples-extra/docs_example/turbo.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "codegen": {
+      "inputs": ["ontology.json"],
+      "outputs": ["src/generatedNoCheck/**/*"],
+      "dependsOn": ["@osdk/cli.cmd.typescript#transpile"]
+    }
+  }
+}

examples-extra/one_dot_one/package.json

@@ -26,24 +26,24 @@
     "codegen": "rm -rf src/generatedNoCheck/* && osdk-unstable-typescript generate --outDir src/generatedNoCheck --ontologyPath ontology.json --version dev --packageType module",
     "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
     "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
-    "transpile": "tsup",
+    "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": "../../scripts/build_common/typecheck.sh both"
+    "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 both"
   },
   "dependencies": {
     "@osdk/api": "workspace:~",
     "@osdk/generator": "workspace:~",
     "@osdk/legacy-client": "workspace:~"
   },
   "peerDependencies": {
-    "@osdk/api": "^1.8.0",
-    "@osdk/legacy-client": "^2.4.0-beta.0"
+    "@osdk/api": "^1.9.0-beta.0",
+    "@osdk/legacy-client": "^2.4.0-beta.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@osdk/api": "^1.8.0",
+    "@osdk/api": "^1.9.0-beta.0",
     "@osdk/cli.cmd.typescript": "workspace:~",
-    "@osdk/legacy-client": "^2.4.0-beta.0",
+    "@osdk/legacy-client": "^2.4.0-beta.1",
     "@types/node": "^18.0.0",
     "tslib": "^2.6.2",
     "typescript": "^4.9.5"

examples-extra/one_dot_one/turbo.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "codegen": {
+      "inputs": ["ontology.json"],
+      "outputs": ["src/generatedNoCheck/**/*"],
+      "dependsOn": ["@osdk/cli.cmd.typescript#transpile"]
+    }
+  }
+}

examples-extra/todoapp/turbo.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "codegen": {
+      "inputs": ["ontology.json"],
+      "outputs": ["src/generatedNoCheck2/**/*"],
+      "dependsOn": ["@osdk/cli.cmd.typescript#transpile"]
+    }
+  }
+}

monorepo/api-extractor/base.json

@@ -0,0 +1,69 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "<projectFolder>/build/esm/index.d.ts",
+  "bundledPackages": [],
+  "newlineKind": "lf",
+
+  "apiReport": {
+    "enabled": true,
+    "reportFileName": "<unscopedPackageName>.report.api.md",
+    "reportFolder": "<projectFolder>/etc/",
+    "reportTempFolder": "<projectFolder>/build/api-extractor/"
+  },
+
+  "docModel": {
+    "enabled": true,
+    "projectFolderUrl": "https://github.com/palantir/osdk-ts/tree/main/packages/client.api",
+    "apiJsonFilePath": "<projectFolder>/build/api-extractor/<unscopedPackageName>.api.json"
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+
+  "dtsRollup": {
+    "enabled": false
+  },
+  //
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+      // "TS2551": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+      // "ae-extra-release-tag": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        "addToApiReportFile": true
+      }
+      // "tsdoc-link-tag-unescaped-text": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    }
+  }
+}

monorepo/api-extractor/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@osdk/api-extractor",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  }
+}

monorepo/mytsup/tsup.mjs

@@ -40,14 +40,15 @@ export default async (options, ourOptions) => {
       ),
       TARGET: "node",
     },
-    clean: true,
+    clean: false, // we do this ourselves so its granular
     silent: true,
     sourcemap: true,
     splitting: true,
     minify: false, // !options.watch,
     onSuccess: async () => {
       console.log("👍");
     },
+    keepNames: false,
     treeshake: true,
     target: "es2022",
 

package.json

@@ -44,7 +44,7 @@
     "tsc-absolute": "^1.0.1",
     "tsconfig": "workspace:~",
     "tsup": "^8.1.0",
-    "turbo": "^1.13.2",
+    "turbo": "^2.0.4",
     "typescript": "^5.5.3",
     "typescript-eslint": "^7.16.0",
     "vitest": "^1.6.0"

packages/api/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @osdk/api
 
+## 1.9.0-beta.0
+
+### Minor Changes
+
+- 388dba9: Change all internal dependencies to be tilde not caret
+
+### Patch Changes
+
+- Updated dependencies [388dba9]
+  - @osdk/shared[email protected]
+
 ## 1.8.0
 
 ### Minor Changes