@party-stack/foundry-ontology 0.18.1 → 0.20.0

package/lib/adapter/likeFilter.js

@@ -0,0 +1,87 @@
+//#region src/adapter/likeFilter.ts
+const ALWAYS_TRUE_FILTER = {
+	type: "and",
+	value: []
+};
+function pushdown(query, safeToNegate = true) {
+	return {
+		query,
+		safeToNegate
+	};
+}
+function parseLikePattern(pattern, literalBackslashes = false) {
+	const parts = [];
+	let literal = "";
+	const flushLiteral = () => {
+		if (literal) {
+			parts.push({
+				type: "literal",
+				value: literal
+			});
+			literal = "";
+		}
+	};
+	for (let index = 0; index < pattern.length; index++) {
+		const character = pattern[index];
+		if (character === "\\" && !literalBackslashes) {
+			const escaped = pattern[index + 1];
+			if (escaped === "%" || escaped === "_" || escaped === "\\") {
+				literal += escaped;
+				index++;
+			} else literal += character;
+		} else if (character === "%") {
+			flushLiteral();
+			parts.push({ type: "many" });
+		} else if (character === "_") {
+			flushLiteral();
+			parts.push({ type: "single" });
+		} else literal += character;
+	}
+	flushLiteral();
+	return parts;
+}
+function escapeFoundryWildcardLiteral(value) {
+	return value.replace(/[\\*?]/g, "\\$&");
+}
+function convertLikeFilter(field, value, literalBackslashes = false) {
+	const parts = parseLikePattern(value.toLowerCase(), literalBackslashes);
+	const hasLeadingWildcard = parts[0]?.type === "many";
+	const hasTrailingWildcard = parts.at(-1)?.type === "many";
+	const propertyIdentifier = fieldPathToPropertyIdentifier(field);
+	if (hasLeadingWildcard && hasTrailingWildcard) {
+		const queries = parts.flatMap((part) => part.type === "literal" && part.value ? [part.value] : []).map((term) => ({
+			type: "containsAllTermsInOrder",
+			propertyIdentifier,
+			value: term
+		}));
+		return pushdown(queries.length === 0 ? ALWAYS_TRUE_FILTER : queries.length === 1 ? queries[0] : {
+			type: "and",
+			value: queries
+		}, false);
+	}
+	return pushdown({
+		type: "wildcard",
+		propertyIdentifier,
+		value: parts.map((part) => {
+			if (part.type === "many") return "*";
+			if (part.type === "single") return "?";
+			return escapeFoundryWildcardLiteral(part.value);
+		}).join("")
+	});
+}
+function fieldPathToPropertyIdentifier(fieldPath) {
+	if (fieldPath.length === 1) return {
+		type: "property",
+		apiName: fieldPath[0]
+	};
+	else if (fieldPath.length === 2) return {
+		type: "structField",
+		propertyApiName: fieldPath[0],
+		structFieldApiName: fieldPath[1]
+	};
+	throw new Error(`Invalid field path: ${fieldPath.join(".")}`);
+}
+//#endregion
+export { convertLikeFilter };
+
+//# sourceMappingURL=likeFilter.js.map

package/lib/adapter/likeFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"likeFilter.js","names":[],"sources":["../../src/adapter/likeFilter.ts"],"sourcesContent":["import type {\n    PropertyApiName,\n    PropertyIdentifier,\n    SearchJsonQueryV2,\n    StructFieldApiName,\n} from \"@osdk/foundry.ontologies\";\n\nconst ALWAYS_TRUE_FILTER: SearchJsonQueryV2 = { type: \"and\", value: [] };\n\ntype LikePatternPart = { type: \"literal\"; value: string } | { type: \"many\" } | { type: \"single\" };\n\ninterface PushdownFilter {\n    query: SearchJsonQueryV2;\n    safeToNegate: boolean;\n}\n\nfunction pushdown(query: SearchJsonQueryV2, safeToNegate = true): PushdownFilter {\n    return { query, safeToNegate };\n}\n\nfunction parseLikePattern(pattern: string, literalBackslashes = false): LikePatternPart[] {\n    const parts: LikePatternPart[] = [];\n    let literal = \"\";\n\n    const flushLiteral = () => {\n        if (literal) {\n            parts.push({ type: \"literal\", value: literal });\n            literal = \"\";\n        }\n    };\n\n    for (let index = 0; index < pattern.length; index++) {\n        const character = pattern[index]!;\n        if (character === \"\\\\\" && !literalBackslashes) {\n            const escaped = pattern[index + 1];\n            if (escaped === \"%\" || escaped === \"_\" || escaped === \"\\\\\") {\n                literal += escaped;\n                index++;\n            } else {\n                literal += character;\n            }\n        } else if (character === \"%\") {\n            flushLiteral();\n            parts.push({ type: \"many\" });\n        } else if (character === \"_\") {\n            flushLiteral();\n            parts.push({ type: \"single\" });\n        } else {\n            literal += character;\n        }\n    }\n    flushLiteral();\n\n    return parts;\n}\n\nfunction escapeFoundryWildcardLiteral(value: string): string {\n    return value.replace(/[\\\\*?]/g, \"\\\\$&\");\n}\n\nexport function convertLikeFilter(\n    field: readonly (string | number)[],\n    value: string,\n    literalBackslashes = false\n): PushdownFilter {\n    const parts = parseLikePattern(value.toLowerCase(), literalBackslashes);\n    const hasLeadingWildcard = parts[0]?.type === \"many\";\n    const hasTrailingWildcard = parts.at(-1)?.type === \"many\";\n    const propertyIdentifier = fieldPathToPropertyIdentifier(field);\n\n    if (hasLeadingWildcard && hasTrailingWildcard) {\n        const terms = parts.flatMap((part) => (part.type === \"literal\" && part.value ? [part.value] : []));\n        const queries = terms.map<SearchJsonQueryV2>((term) => ({\n            // This is Foundry's substring/phrase query. It can over-fetch because\n            // wildcard-delimited terms are not required to be adjacent or ordered.\n            type: \"containsAllTermsInOrder\",\n            propertyIdentifier,\n            value: term,\n        }));\n        const query: SearchJsonQueryV2 =\n            queries.length === 0\n                ? ALWAYS_TRUE_FILTER\n                : queries.length === 1\n                  ? queries[0]!\n                  : { type: \"and\", value: queries };\n\n        // Contains is an approximation of SQL LIKE. Negating this superset\n        // would produce a subset and could hide exact matches.\n        return pushdown(query, false);\n    }\n\n    const wildcard = parts\n        .map((part) => {\n            if (part.type === \"many\") return \"*\";\n            if (part.type === \"single\") return \"?\";\n            return escapeFoundryWildcardLiteral(part.value);\n        })\n        .join(\"\");\n\n    return pushdown({\n        type: \"wildcard\",\n        propertyIdentifier,\n        value: wildcard,\n    });\n}\n\nfunction fieldPathToPropertyIdentifier(fieldPath: readonly (string | number)[]): PropertyIdentifier {\n    if (fieldPath.length === 1) {\n        return {\n            type: \"property\",\n            apiName: fieldPath[0]! as PropertyApiName,\n        };\n    } else if (fieldPath.length === 2) {\n        return {\n            type: \"structField\",\n            propertyApiName: fieldPath[0]! as PropertyApiName,\n            structFieldApiName: fieldPath[1]! as StructFieldApiName,\n        };\n    }\n    throw new Error(`Invalid field path: ${fieldPath.join(\".\")}`);\n}\n"],"mappings":";AAOA,MAAM,qBAAwC;CAAE,MAAM;CAAO,OAAO,CAAC;AAAE;AASvE,SAAS,SAAS,OAA0B,eAAe,MAAsB;CAC7E,OAAO;EAAE;EAAO;CAAa;AACjC;AAEA,SAAS,iBAAiB,SAAiB,qBAAqB,OAA0B;CACtF,MAAM,QAA2B,CAAC;CAClC,IAAI,UAAU;CAEd,MAAM,qBAAqB;EACvB,IAAI,SAAS;GACT,MAAM,KAAK;IAAE,MAAM;IAAW,OAAO;GAAQ,CAAC;GAC9C,UAAU;EACd;CACJ;CAEA,KAAK,IAAI,QAAQ,GAAG,QAAQ,QAAQ,QAAQ,SAAS;EACjD,MAAM,YAAY,QAAQ;EAC1B,IAAI,cAAc,QAAQ,CAAC,oBAAoB;GAC3C,MAAM,UAAU,QAAQ,QAAQ;GAChC,IAAI,YAAY,OAAO,YAAY,OAAO,YAAY,MAAM;IACxD,WAAW;IACX;GACJ,OACI,WAAW;EAEnB,OAAO,IAAI,cAAc,KAAK;GAC1B,aAAa;GACb,MAAM,KAAK,EAAE,MAAM,OAAO,CAAC;EAC/B,OAAO,IAAI,cAAc,KAAK;GAC1B,aAAa;GACb,MAAM,KAAK,EAAE,MAAM,SAAS,CAAC;EACjC,OACI,WAAW;CAEnB;CACA,aAAa;CAEb,OAAO;AACX;AAEA,SAAS,6BAA6B,OAAuB;CACzD,OAAO,MAAM,QAAQ,WAAW,MAAM;AAC1C;AAEA,SAAgB,kBACZ,OACA,OACA,qBAAqB,OACP;CACd,MAAM,QAAQ,iBAAiB,MAAM,YAAY,GAAG,kBAAkB;CACtE,MAAM,qBAAqB,MAAM,EAAE,EAAE,SAAS;CAC9C,MAAM,sBAAsB,MAAM,GAAG,EAAE,CAAC,EAAE,SAAS;CACnD,MAAM,qBAAqB,8BAA8B,KAAK;CAE9D,IAAI,sBAAsB,qBAAqB;EAE3C,MAAM,UADQ,MAAM,SAAS,SAAU,KAAK,SAAS,aAAa,KAAK,QAAQ,CAAC,KAAK,KAAK,IAAI,CAAC,CAC3E,CAAC,CAAC,KAAwB,UAAU;GAGpD,MAAM;GACN;GACA,OAAO;EACX,EAAE;EAUF,OAAO,SARH,QAAQ,WAAW,IACb,qBACA,QAAQ,WAAW,IACjB,QAAQ,KACR;GAAE,MAAM;GAAO,OAAO;EAAQ,GAInB,KAAK;CAChC;CAUA,OAAO,SAAS;EACZ,MAAM;EACN;EACA,OAXa,MACZ,KAAK,SAAS;GACX,IAAI,KAAK,SAAS,QAAQ,OAAO;GACjC,IAAI,KAAK,SAAS,UAAU,OAAO;GACnC,OAAO,6BAA6B,KAAK,KAAK;EAClD,CAAC,CAAC,CACD,KAAK,EAKQ;CAClB,CAAC;AACL;AAEA,SAAS,8BAA8B,WAA6D;CAChG,IAAI,UAAU,WAAW,GACrB,OAAO;EACH,MAAM;EACN,SAAS,UAAU;CACvB;MACG,IAAI,UAAU,WAAW,GAC5B,OAAO;EACH,MAAM;EACN,iBAAiB,UAAU;EAC3B,oBAAoB,UAAU;CAClC;CAEJ,MAAM,IAAI,MAAM,uBAAuB,UAAU,KAAK,GAAG,GAAG;AAChE"}

package/lib/adapter/makeFoundryOntologyBackend.d.ts

@@ -0,0 +1,76 @@
+import { OntologyClient } from "@party-stack/foundry-client";
+import { Effect, Stream, Types } from "effect";
+import { ActionReceipt, BackendAttachments, BackendError, BackendSnapshot } from "@party-stack/ontology-backend";
+import { OntologyIR } from "@party-stack/ontology-spec";
+import { ByteInput } from "@party-stack/ontology-storage/blobs";
+import { Query } from "@party-stack/ontology-storage";
+import { attachment } from "@party-stack/ontology-spec/values";
+//#region src/adapter/makeFoundryOntologyBackend.d.ts
+type PartialAttachmentMetadata = Types.Mutable<Effect.Success<ReturnType<BackendAttachments["metadata"]>>>;
+export declare function isFoundryNotFoundError(error: unknown): boolean;
+export interface FoundryUsersIntegration {
+  objectType: string;
+  loadSubset(client: OntologyClient, query: Query, signal: AbortSignal): Promise<BackendSnapshot>;
+  getAttachmentContent?(client: OntologyClient, attachment: attachment): Promise<ByteInput | undefined>;
+  getAttachmentMetadata?(client: OntologyClient, attachment: attachment, selection: readonly (keyof PartialAttachmentMetadata)[]): Promise<PartialAttachmentMetadata | undefined>;
+}
+export interface FoundryOntologyBackendOptions {
+  client: OntologyClient;
+  ir: OntologyIR;
+  users?: FoundryUsersIntegration;
+  watch?: boolean;
+  context?: Record<string, unknown>;
+}
+export declare const makeFoundryOntologyBackend: (opts: FoundryOntologyBackendOptions) => Effect.Effect<{
+  name: string;
+  sourceId: string;
+  supportsIdempotency: boolean;
+  maintenance?: Effect.Effect<void, BackendError>;
+  loadSubset: (subset: import("@party-stack/ontology-spec/query").ObjectSubset) => Effect.Effect<BackendSnapshot, BackendError>;
+  query: (document: import("@party-stack/ontology-spec").QueryDocument, options?: {
+    readonly inputs?: Record<string, unknown>;
+  }) => Effect.Effect<Record<string, unknown>, BackendError>;
+  subscribeSelection?: (selection: import("@party-stack/ontology-backend").ObjectSelection, policy?: import("@party-stack/ontology-backend/delivery").DeliveryPolicy, resume?: import("@party-stack/ontology-backend/delivery").DeliveryPosition) => Effect.Effect<import("@party-stack/ontology-backend/delivery").DeliverySubscription, BackendError, import("effect/Scope").Scope>;
+  acknowledgeDelivery?: (position: import("@party-stack/ontology-backend/delivery").DeliveryPosition) => Effect.Effect<void, BackendError>;
+  resolveActionParameters?: (name: string, parameters: Record<string, unknown>) => Effect.Effect<Record<string, unknown>, BackendError>;
+  watchSubset?: (subset: import("@party-stack/ontology-spec/query").ObjectSubset) => Effect.Effect<Stream.Stream<import("@party-stack/ontology-backend").SubsetWatchEvent, BackendError>, BackendError, import("effect/Scope").Scope> | undefined;
+  refresh?: (subset: import("@party-stack/ontology-spec/query").ObjectSubset) => {
+    readonly pollIntervalMs?: number | false;
+    readonly maxCoverageAgeMs?: number;
+  } | undefined;
+  applyAction: (invocation: import("@party-stack/ontology-backend").ActionRequest) => Effect.Effect<ActionReceipt, BackendError>;
+  queryFunction: (name: string, parameters: Record<string, unknown>) => Effect.Effect<unknown, BackendError>;
+  changes?: {
+    readonly pull: (options: {
+      readonly cursor?: string;
+      readonly limit?: number;
+    }) => Effect.Effect<import("@party-stack/ontology-backend").BackendChangePage, BackendError>;
+    readonly watch?: Effect.Effect<Stream.Stream<void, BackendError>, BackendError, import("effect/Scope").Scope>;
+  };
+  attachments?: BackendAttachments;
+  encrypted?: import("@party-stack/ontology-backend").BackendEncryptedValues;
+  validateAction: (name: string, parameters: Record<string, unknown>, settings?: {
+    readonly knownParameters?: readonly string[];
+  }) => Effect.Effect<{
+    readonly certain: false;
+  } | {
+    readonly certain: true;
+    readonly value: {
+      readonly kind: "ok";
+      readonly value: void;
+    } | {
+      readonly kind: "err";
+      readonly value: readonly {
+        readonly message: string;
+        readonly path?: readonly (string | number)[] | undefined;
+        readonly code?: string | undefined;
+        readonly category?: "custom" | "input" | "reference" | undefined;
+        readonly source?: "parameter" | "submission" | "user-facing" | undefined;
+        readonly messageSource?: "configured" | "standard" | undefined;
+      }[];
+    };
+  }, BackendError<"Conflict" | "Forbidden" | "HistoryExpired" | "Internal" | "InvalidConfiguration" | "InvalidRequest" | "InvalidResponse" | "NotFound" | "NotImplemented" | "RateLimited" | "ResultExpired" | "SchemaMismatch" | "SessionExpired" | "SessionReplaced" | "SourceMismatch" | "Unauthenticated" | "Unavailable" | "ValidationFailed" | "ViewReplaced">, never>;
+}, BackendError<"Conflict" | "Forbidden" | "HistoryExpired" | "Internal" | "InvalidConfiguration" | "InvalidRequest" | "InvalidResponse" | "NotFound" | "NotImplemented" | "RateLimited" | "ResultExpired" | "SchemaMismatch" | "SessionExpired" | "SessionReplaced" | "SourceMismatch" | "Unauthenticated" | "Unavailable" | "ValidationFailed" | "ViewReplaced">, import("effect/Scope").Scope>;
+//#endregion
+export {};
+//# sourceMappingURL=makeFoundryOntologyBackend.d.ts.map

package/lib/adapter/makeFoundryOntologyBackend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"makeFoundryOntologyBackend.d.ts","names":[],"sources":["../../src/adapter/makeFoundryOntologyBackend.ts"],"mappings":";;;;;;;;KA4CK,4BAA4B,MAAM,QAAQ,OAAO,QAAQ,WAAW;wBAiBzD,uBAAuB;iBAWtB;EACb;EACA,WAAW,QAAQ,gBAAgB,OAAO,OAAO,QAAQ,cAAc,QAAQ;EAC/E,sBAAsB,QAAQ,gBAAgB,YAAY,aAAa,QAAQ;EAC/E,uBACI,QAAQ,gBACR,YAAY,YACZ,2BAA2B,+BAC5B,QAAQ;;iBA2HE;EACb,QAAQ;EACR,IAAI;EACJ,QAAQ;EACR;EACA,UAAU;;qBAgBD,6BAA0B,MAAA,kCAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6jBjB,iBAAA,cAAM,YACA,yBAAuB;aACb;QAAqC,OAAA;;;;;;;;;;;;;;;;;;;GAUzE,wXAAA"}