@osdk/integration-testing 0.0.0 → 0.1.0

package/build/types/types.d.ts

@@ -0,0 +1,104 @@
+import type { LinkTypeApiNamesFor, PrimaryKeyType } from "@osdk/api";
+import type { Client, ObjectTypeDefinition } from "@osdk/client";
+import type { OntologyFullMetadata } from "@osdk/foundry.ontologies";
+import type { LinkTargets, SeedFunction, SeedOutput, SeedProps, SeedRef } from "@osdk/seed-helpers";
+import type { MockClient } from "@osdk/unit-testing";
+export type IntegrationClient = Client & {
+	whenQuery: MockClient["whenQuery"]
+	clearStubs(): MockClient["clearStubs"]
+};
+export interface IntegrationClientConfig {
+	baseUrl: string;
+	metadata: OntologyFullMetadata;
+	caCertPath?: string;
+}
+export interface IntegrationServerConfig {
+	/** Path to a prebuilt ontology metadata JSON. */
+	metadata: OntologyFullMetadata;
+	/** Path to the `foundry` binary. Defaults to `foundry` on `PATH`. */
+	foundryCliPath?: string;
+	/**
+	* Directory to create this server's run directory in. Each server gets its
+	* own `.test-run-*` beneath it, removed on {@link IntegrationServer.stop}, so
+	* servers sharing a `projectPath` stay isolated. Must already exist; defaults
+	* to the working directory.
+	*/
+	projectPath?: string;
+}
+export interface IntegrationServer {
+	start(): Promise<void>;
+	stop(): Promise<void>;
+	getOntologyUrl(): string | undefined;
+	getSeedClient(): Promise<SeedClient>;
+	getClient(): Promise<IntegrationClient>;
+}
+export type SeedClient = {
+	/**
+	* Transactional interface to SeedBuilder
+	* Applies changes if function is provided, calls .addAll(seed) if SeedOutput is provided.
+	*/
+	<T = void>(seed: SeedFunction<T> | SeedOutput): Promise<T>
+	/**
+	* Returns a reference to an object already in the seed, or `undefined` if none
+	* exists. Read-only: nothing is applied to the server.
+	* @param o Object type definition
+	* @param primaryKey Primary key value of the object
+	* @returns Reference to the object, or `undefined` if not found
+	*/
+	ref<Q extends ObjectTypeDefinition>(o: Q, primaryKey: PrimaryKeyType<Q>): SeedRef<Q> | undefined
+	/**
+	* Replaces the entire seed with `seed` and applies it, discarding everything
+	* accumulated so far. Clears the seed when called with no argument.
+	* @param seed Seed output to reset to, or `undefined` to clear
+	*/
+	set(seed?: SeedOutput): Promise<void>
+	/**
+	* Merges an existing seed output into the current seed and applies it.
+	* @param seed Seed output to merge in; must match the metadata the client was created with
+	*/
+	addAll(seed: SeedOutput): Promise<void>
+	/**
+	* Creates an object of the given type and applies the seed.
+	* @param o Object type definition
+	* @param props Object properties, including its primary key
+	* @returns Reference to the created object
+	* @throws {Error} if an object of that type already exists with the same primary key
+	*/
+	create<Q extends ObjectTypeDefinition>(o: Q, props: SeedProps<Q>): Promise<SeedRef<Q>>
+	/**
+	* Merges `props` into the referenced object and applies the seed. Properties not
+	* included are left unchanged; the object is created if it does not yet exist.
+	* @param ref Reference to the object to update
+	* @param props Partial object properties to merge in, excluding the primary key
+	* @returns The same reference passed in
+	*/
+	update<Q extends ObjectTypeDefinition>(ref: SeedRef<Q>, props: Partial<Omit<SeedProps<Q>, Exclude<Q["primaryKeyApiName"], undefined>>>): Promise<SeedRef<Q>>
+	/**
+	* Removes the referenced object from the seed and applies it. No-op if the object
+	* does not exist.
+	* @param ref Reference to the object to delete
+	*/
+	delete<Q extends ObjectTypeDefinition>(ref: SeedRef<Q>): Promise<void>
+	/**
+	* Links the source object to one or more targets via the given link type and
+	* applies the seed. Re-adding an existing link is a no-op.
+	* @param source Reference to the source object
+	* @param apiName Link type API name
+	* @param target Reference (or references) to the target object(s)
+	*/
+	link<
+		Q extends ObjectTypeDefinition,
+		A extends LinkTypeApiNamesFor<Q>
+	>(source: SeedRef<Q>, apiName: A, target: LinkTargets<Q, A>): Promise<void>
+	/**
+	* Removes links from the source object to the given targets via the link type and
+	* applies the seed. No-op if no matching links exist.
+	* @param source Reference to the source object
+	* @param apiName Link type API name
+	* @param target Reference (or references) to the target object(s)
+	*/
+	unlink<
+		Q extends ObjectTypeDefinition,
+		A extends LinkTypeApiNamesFor<Q>
+	>(source: SeedRef<Q>, apiName: A, target: LinkTargets<Q, A>): Promise<void>
+};

package/build/types/types.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,qBAAqB,sBAAsB,WAAY;AACrE,cAAc,QAAQ,4BAA4B,cAAe;AACjE,cAAc,4BAA4B,0BAA2B;AACrE,cACE,aACA,cACA,YACA,WACA,eACK,oBAAqB;AAC5B,cAAc,kBAAkB,oBAAqB;AAErD,YAAY,oBAAoB,SAAS;CAEvC,WAAW,WAAW;CACtB,cAAc,WAAW;AAC1B;AAED,iBAAiB,wBAAwB;CACvC;CACA,UAAU;CACV;AACD;AAED,iBAAiB,wBAAwB;;CAEvC,UAAU;;CAEV;;;;;;;CAOA;AACD;AAED,iBAAiB,kBAAkB;CACjC,SAAS;CACT,QAAQ;CACR;CACA,iBAAiB,QAAQ;CACzB,aAAa,QAAQ;AACtB;AAED,YAAY,aAAa;;;;;EAKtB,UAAUA,MAAM,aAAa,KAAK,aAAa,QAAQ;;;;;;;;CAQxD,IAAI,UAAU,sBACZC,GAAG,GACHC,YAAY,eAAe,KAC1B,QAAQ;;;;;;CAMX,IAAIC,OAAO,aAAa;;;;;CAKxB,OAAOC,MAAM,aAAa;;;;;;;;CAQ1B,OAAO,UAAU,sBACfH,GAAG,GACHI,OAAO,UAAU,KAChB,QAAQ,QAAQ;;;;;;;;CAQnB,OAAO,UAAU,sBACfC,KAAK,QAAQ,IACbC,OAAO,QACL,KAAK,UAAU,IAAI,QAAQ,EAAE,qCAE9B,QAAQ,QAAQ;;;;;;CAMnB,OAAO,UAAU,sBAAsBD,KAAK,QAAQ,KAAK;;;;;;;;CAQzD;EAAK,UAAU;EAAsB,UAAU,oBAAoB;GACjEE,QAAQ,QAAQ,IAChBC,SAAS,GACTC,QAAQ,YAAY,GAAG,KACtB;;;;;;;;CAQH;EAAO,UAAU;EAAsB,UAAU,oBAAoB;GACnEF,QAAQ,QAAQ,IAChBC,SAAS,GACTC,QAAQ,YAAY,GAAG,KACtB;AACJ","names":["seed: SeedFunction<T> | SeedOutput","o: Q","primaryKey: PrimaryKeyType<Q>","seed?: SeedOutput","seed: SeedOutput","props: SeedProps<Q>","ref: SeedRef<Q>","props: Partial<\n      Omit<SeedProps<Q>, Exclude<Q[\"primaryKeyApiName\"], undefined>>\n    >","source: SeedRef<Q>","apiName: A","target: LinkTargets<Q, A>"],"sources":["../../src/types.ts"],"version":3,"file":"types.d.ts"}

package/build/types/utils/empty-ontology-block.d.ts

@@ -0,0 +1,4 @@
+import type { PreviewOntologyIrConverter } from "@osdk/generator-converters.preview";
+type OntologyBlockDataV2 = Parameters<typeof PreviewOntologyIrConverter.getPreviewFullMetadataFromBlockData>[0];
+export declare const EMPTY_ONTOLOGY_BLOCK_DATA: OntologyBlockDataV2;
+export {};

package/build/types/utils/empty-ontology-block.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,kCAAkC,oCAAqC;KAEhF,sBAAsB,kBAClB,2BAA2B,qCAClC;AAEF,OAAO,cAAMA,2BAA2B","names":["EMPTY_ONTOLOGY_BLOCK_DATA: OntologyBlockDataV2"],"sources":["../../../src/utils/empty-ontology-block.ts"],"version":3,"file":"empty-ontology-block.d.ts"}

package/build/types/utils/foundry-cli.d.ts

@@ -0,0 +1,13 @@
+export declare const MIN_FOUNDRY_CLI_VERSION = "0.224.0";
+export type FoundryProbeResult = {
+	type: "installed"
+	version: string
+} | {
+	type: "version-incompatible"
+	version: string
+} | {
+	type: "version-error"
+} | {
+	type: "not-found"
+};
+export declare const checkFoundryCliVersion: () => Promise<FoundryProbeResult>;

package/build/types/utils/foundry-cli.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAqBA,OAAO,cAAM,0BAA0B;AAKvC,YAAY,qBACR;CACE,MAAM;CACN;AACD,IACD;CACE,MAAM;CACN;AACD,IACD;CACE,MAAM;AACP,IACD;CACE,MAAM;AACP;AAUL,OAAO,cAAM,8BAA6B,QAAQ","names":[],"sources":["../../../src/utils/foundry-cli.ts"],"version":3,"file":"foundry-cli.d.ts"}

package/build/types/utils/process.d.ts

@@ -0,0 +1 @@
+export declare const isProcessAlive: (pid: number) => boolean;

package/build/types/utils/process.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,OAAO,cAAM,iBAAkBA","names":["pid: number"],"sources":["../../../src/utils/process.ts"],"version":3,"file":"process.d.ts"}

package/build/types/utils/service.d.ts

@@ -0,0 +1,4 @@
+import type { ServiceName } from "../generated/cli/__components.js";
+export declare const serviceNameFromFileName: (fileName: string) => ServiceName | undefined;
+/** The name a running service publishes its discovery record under. */
+export declare const discoveryFileName: (name: ServiceName) => string;

package/build/types/utils/service.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,mBAAmB,kCAAmC;AAkBpE,OAAO,cAAM,0BACXA,qBACC;;AAOH,OAAO,cAAM,oBAAqBC,MAAM","names":["fileName: string","name: ServiceName"],"sources":["../../../src/utils/service.ts"],"version":3,"file":"service.d.ts"}

package/package.json

@@ -1 +1,93 @@
-{ "name": "@osdk/integration-testing", "version": "0.0.0" }
+{
+  "name": "@osdk/integration-testing",
+  "version": "0.1.0",
+  "description": "Integration-testing helpers for the Ontology SDK",
+  "access": "public",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
+  "exports": {
+    ".": {
+      "browser": "./build/browser/index.js",
+      "import": {
+        "types": "./build/types/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": "./build/cjs/index.cjs",
+      "default": "./build/browser/index.js"
+    },
+    "./*": {
+      "browser": "./build/browser/public/*.js",
+      "import": {
+        "types": "./build/types/public/*.d.ts",
+        "default": "./build/esm/public/*.js"
+      },
+      "require": "./build/cjs/public/*.cjs",
+      "default": "./build/browser/public/*.js"
+    }
+  },
+  "dependencies": {
+    "@osdk/foundry.ontologies": "2.70.0",
+    "conjure-lite": "^0.7.3",
+    "consola": "^3.4.2",
+    "semver": "^7.7.2",
+    "tiny-invariant": "^1.3.3",
+    "undici": "^6.28.0",
+    "@osdk/generator-converters.preview": "~0.34.0",
+    "@osdk/unit-testing": "~0.21.0"
+  },
+  "peerDependencies": {
+    "@osdk/seed-helpers": ">=0.25.0 <1.0.0",
+    "@osdk/api": "^2.56.0",
+    "@osdk/client": "^2.56.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-documenter": "^7.26.32",
+    "@microsoft/api-extractor": "^7.52.11",
+    "@types/node": "^26.1.1",
+    "@types/semver": "^7.7.1",
+    "typescript": "~5.5.4",
+    "vitest": "^3.2.4",
+    "@osdk/api": "~2.56.0",
+    "@osdk/monorepo.api-extractor": "~0.7.0",
+    "@osdk/monorepo.tsconfig": "~0.7.0",
+    "@osdk/seed-helpers": "~0.26.0",
+    "@osdk/client": "~2.56.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "bin/postinstall.mjs",
+    "build/cjs",
+    "build/esm",
+    "build/browser",
+    "build/types",
+    "CHANGELOG.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "main": "./build/cjs/index.cjs",
+  "module": "./build/esm/index.js",
+  "types": "./build/cjs/index.d.cts",
+  "type": "module",
+  "scripts": {
+    "check-api": "api-extractor run --verbose --local",
+    "check-attw": "attw --pack .",
+    "check-spelling": "cspell --quiet .",
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "oxlint -c ./oxlint.config.ts --fix . && oxfmt -c ../../oxfmt.config.ts .",
+    "generateConjure": "node ./bin/generateConjure.mjs",
+    "lint": "oxlint -c ./oxlint.config.ts . && oxfmt -c ../../oxfmt.config.ts --check .",
+    "postinstall": "node ./bin/postinstall.mjs",
+    "test": "vitest run --pool=forks",
+    "transpileBrowser": "monorepo.tool.transpile -f esm -m normal -t browser",
+    "transpileCjs": "monorepo.tool.transpile -f cjs -m bundle -t node",
+    "transpileEsm": "monorepo.tool.transpile -f esm -m normal -t node",
+    "transpileTypes": "monorepo.tool.transpile -f esm -m types -t node",
+    "typecheck": "tsc --noEmit --emitDeclarationOnly false"
+  }
+}