@octostar/platform-types 0.2.1 → 0.2.3

package/lib/ontology.d.ts

@@ -0,0 +1,176 @@
+import { Callback, Unsubscribe } from './callback';
+import { Concept, Entity, Inheritance, Relationship, WorkspaceItem, WorkspaceRelationship } from './model';
+import { QueryResponse, SendQueryOptions } from './query';
+/**
+ * @beta
+ * Type representing the result of a relationship count operation.
+ */
+export type RelationshipCountResult = {
+    /** The count of the relationships. */
+    count: number;
+    /** Whether the count is expired. */
+    expired?: boolean;
+};
+/**
+ * @beta
+ * Interface representing ontology operations.
+ */
+export interface Ontology {
+    /**
+     * Cancels queries in the given context.
+     * @param context - The context in which to cancel queries.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    cancelQueries: (context: string) => Promise<void>;
+    /**
+     * Gets the available ontologies.
+     * @returns A promise that resolves to an array of available ontology names.
+     */
+    getAvailableOntologies: () => Promise<string[]>;
+    /**
+     * Gets workspace relationship records for a given entity and relationship.
+     * @param entity - The entity for which to get relationship records.
+     * @param rel - The relationship or relationship name.
+     * @returns A promise that resolves to an array of workspace relationships.
+     */
+    getWorkspaceRelationshipRecords(entity: Entity, rel: string | Relationship): Promise<WorkspaceRelationship[]>;
+    /**
+     * Clears the relationship cache for a given entity and relationship.
+     * @param entity - The entity for which to clear the cache.
+     * @param relationship - The relationship or relationship name.
+     * @param inverse - Whether to clear the inverse relationship cache.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    clearRelationshipCache: (entity: Entity, relationship: Relationship | string, inverse?: boolean) => Promise<void>;
+    /**
+     * Gets connected entities for a given entity and relationship.
+     * @param entity - The entity for which to get connected entities.
+     * @param relationship - The relationship or relationship name.
+     * @param forceRefresh - Whether to force a refresh of the data.
+     * @returns A promise that resolves to an array of connected entities.
+     */
+    getConnectedEntities: <T extends Entity>(entity: Entity, relationship: Relationship | string, forceRefresh?: boolean) => Promise<T[]>;
+    /**
+     * Gets a concept by its name.
+     * @param conceptName - The name of the concept.
+     * @returns A promise that resolves to the concept or undefined if not found.
+     */
+    getConceptByName: (conceptName: string) => Promise<Concept | undefined>;
+    /**
+     * Gets all concepts.
+     * @returns A promise that resolves to a map of concept names to concepts.
+     */
+    getConcepts: () => Promise<Map<string, Concept>>;
+    /**
+     * Gets an entity.
+     * @param e - The entity to get.
+     * @param refresh - Whether to refresh the data.
+     * @param skipSideEffects - Whether to skip side effects.
+     * @returns A promise that resolves to the entity.
+     */
+    getEntity: <T extends Entity>(e: Entity, refresh?: boolean, skipSideEffects?: boolean) => Promise<T>;
+    /**
+     * Gets the name of the ontology.
+     * @returns A promise that resolves to the name of the ontology.
+     */
+    getOntologyName: () => Promise<string>;
+    /**
+     * Gets the relationship count for a given entity and relationship.
+     * @param entity - The entity for which to get the relationship count.
+     * @param rel - The relationship or relationship name.
+     * @param forceRefresh - Whether to force a refresh of the data.
+     * @returns A promise that resolves to the relationship count result.
+     */
+    getRelationshipCount: (entity: Entity, rel: Relationship | string, forceRefresh?: boolean) => Promise<RelationshipCountResult>;
+    /**
+     * Gets the concept for a given entity.
+     * @param entity - The entity for which to get the concept.
+     * @returns A promise that resolves to the concept or undefined if not found.
+     */
+    getConceptForEntity: (entity: Entity) => Promise<Concept | undefined>;
+    /**
+     * Gets the relationships for a given entity.
+     * @param entity - The entity for which to get relationships.
+     * @returns A promise that resolves to an array of relationships.
+     */
+    getRelationshipsForEntity: (entity: Entity) => Promise<Relationship[]>;
+    /**
+     * Sends a query.
+     * @param query - The query string.
+     * @param options - Optional options for sending the query.
+     * @returns A promise that resolves to the query response.
+     */
+    sendQuery: (query: string, options?: SendQueryOptions) => Promise<QueryResponse>;
+    /**
+     * Sends a query with a typed response.
+     * @param query - The query string.
+     * @param options - Optional options for sending the query.
+     * @param force_refresh - Whether to force a refresh of the data.
+     * @returns A promise that resolves to an array of results.
+     */
+    sendQueryT: <T>(query: string, options?: SendQueryOptions, force_refresh?: boolean) => Promise<T[]>;
+    /**
+     * Gets the system inheritance.
+     * @returns A promise that resolves to an array of inheritances.
+     */
+    getSysInheritance(): Promise<Inheritance[]>;
+    /**
+     * Subscribes to changes for a given entity.
+     * @param entity - The entity to subscribe to.
+     * @param callback - The callback to invoke on changes.
+     * @returns A promise that resolves to an unsubscribe function.
+     */
+    subscribe: <T>(entity: Entity, callback: Callback<T>) => Promise<Unsubscribe>;
+    /**
+     * Generates a consistent UUID.
+     * @param name - The name for which to generate the UUID.
+     * @param namespace - Optional namespace for the UUID.
+     * @returns A promise that resolves to the UUID.
+     */
+    consistentUUID: (name: string, namespace?: string) => Promise<string>;
+    /**
+     * Updates the cache with the given entities.
+     * @param entities - The entities to update in the cache.
+     * @returns A promise that resolves to the updated entities.
+     */
+    updateCache: (entities: (Entity & WorkspaceItem)[]) => Promise<(Entity & WorkspaceItem)[]>;
+}
+/**
+ * @beta
+ * Type representing the details of an ontology to be shown.
+ */
+export type ShowOntology = {
+    /** The concept of the ontology. */
+    concept: string;
+    /** The properties of the ontology. */
+    properties: string | undefined;
+    /** The primary keys of the ontology. */
+    primary_keys: string | undefined;
+    /** The label keys of the ontology. */
+    label_keys: string | undefined;
+    /** The inheritance of the ontology. */
+    inheritance: string | undefined;
+    /** The inheritance level of the ontology. */
+    inheritance_level: number;
+    /** The query associated with the ontology. */
+    query: string | undefined;
+    /** The description of the ontology. */
+    description: string | undefined;
+    /** The JSON representation of the query. */
+    query_json: string | undefined;
+};
+/**
+ * @beta
+ * Type representing tags associated with an ontology.
+ */
+export type OntologyTags = {
+    /** The target type of the tag. */
+    target_type: string;
+    /** The target name of the tag. */
+    target_name: string;
+    /** The name of the tag. */
+    tag_name: string;
+    /** The value of the tag. */
+    tag_value: string;
+};
+//# sourceMappingURL=ontology.d.ts.map

package/lib/ontology.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ontology.d.ts","sourceRoot":"","sources":["../src/ontology.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,OAAO,EACP,MAAM,EACN,WAAW,EACX,YAAY,EACZ,aAAa,EACb,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;OAGG;IACH,sBAAsB,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,+BAA+B,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GAAG,YAAY,GACzB,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,sBAAsB,EAAE,CACtB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GAAG,MAAM,EACnC,OAAO,CAAC,EAAE,OAAO,KACd,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,oBAAoB,EAAE,CAAC,CAAC,SAAS,MAAM,EACrC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GAAG,MAAM,EACnC,YAAY,CAAC,EAAE,OAAO,KACnB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAExE;;;OAGG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,MAAM,EAC1B,CAAC,EAAE,MAAM,EACT,OAAO,CAAC,EAAE,OAAO,EACjB,eAAe,CAAC,EAAE,OAAO,KACtB,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhB;;;OAGG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,EAAE,CACpB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,YAAY,GAAG,MAAM,EAC1B,YAAY,CAAC,EAAE,OAAO,KACnB,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtC;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEtE;;;;OAIG;IACH,yBAAyB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAEvE;;;;;OAKG;IACH,SAAS,EAAE,CACT,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5B;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,CAAC,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,gBAAgB,EAC1B,aAAa,CAAC,EAAE,OAAO,KACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAElB;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtE;;;;OAIG;IACH,WAAW,EAAE,CACX,QAAQ,EAAE,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,KACjC,OAAO,CAAC,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,sCAAsC;IACtC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,uCAAuC;IACvC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,6CAA6C;IAC7C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,uCAAuC;IACvC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,4CAA4C;IAC5C,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/lib/ontology.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ontology.js.map

package/lib/ontology.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ontology.js","sourceRoot":"","sources":["../src/ontology.ts"],"names":[],"mappings":""}

package/lib/query.d.ts

@@ -0,0 +1,70 @@
+import { ApiResult } from './api';
+/**
+ * @beta
+ * Type representing a successful query result.
+ * @template T - The type of the data returned.
+ */
+export type QuerySuccessResult<T> = {
+    /** The status of the query result, always 'success' for this type. */
+    status: 'success';
+    /** The data returned by the query. */
+    data: T[];
+};
+/**
+ * @beta
+ * Type representing an error query result.
+ */
+export type QueryErrorResult = {
+    /** The status of the query result, always 'error' for this type. */
+    status: 'error';
+    /** The error message or data. */
+    data: string;
+};
+/**
+ * @beta
+ * Type representing a batch query result, which includes a query ID.
+ * @template T - The type of the data returned in case of success.
+ */
+export type QueryBatchResult<T> = (QuerySuccessResult<T> | QueryErrorResult) & {
+    /** The ID of the query. */
+    query_id: string;
+};
+/**
+ * @beta
+ * Type representing a query response, which is an array of any type.
+ */
+export type QueryResponse = any[];
+/**
+ * @beta
+ * Options for sending a query.
+ */
+export type SendQueryOptions = {
+    /** The context in which to send the query. */
+    context?: string;
+    /** Whether to send the query with low priority. */
+    lowPriority?: boolean;
+};
+/**
+ * @beta
+ * Type representing a query, which can be a string or a function returning a promise.
+ */
+export type Query = string | (() => Promise<string | string[] | undefined>);
+/**
+ * @beta
+ * Interface representing a query executor.
+ */
+export type QueryExecutor = {
+    /**
+     * Sends a query.
+     * @param query - The query to send.
+     * @param options - Optional options for sending the query.
+     * @returns A promise that resolves to the query response.
+     */
+    sendQuery: (query: Query, options?: SendQueryOptions) => Promise<QueryResponse>;
+};
+/**
+ * @beta
+ * Type representing a query result, which is an API result containing an array of any type.
+ */
+export type QueryResult = ApiResult<any[]>;
+//# sourceMappingURL=query.d.ts.map

package/lib/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,sEAAsE;IACtE,MAAM,EAAE,SAAS,CAAC;IAClB,sCAAsC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAC;CACX,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,oEAAoE;IACpE,MAAM,EAAE,OAAO,CAAC;IAChB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,GAAG;IAC7E,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;AAE5E;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,SAAS,EAAE,CACT,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC"}

package/lib/query.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=query.js.map

package/lib/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":""}

package/lib/react-types.d.ts

@@ -0,0 +1,31 @@
+import { Properties } from 'csstype';
+/**
+ * @beta
+ * Type representing a React component.
+ */
+export interface RefObject<T> {
+    readonly current: T | null;
+}
+/**
+ * @beta
+ * Type representing a React ref callback.
+ */
+export type RefCallback<T> = {
+    bivarianceHack(instance: T | null): void;
+}['bivarianceHack'];
+/**
+ * @beta
+ * Type representing a React ref.
+ */
+export type ReactRef<T> = RefCallback<T> | RefObject<T> | null;
+/**
+ * @beta
+ * Type representing a React CSS properties object.
+ */
+export type ReactCssProperties = Properties<string | number>;
+/**
+ * Represents a React node.
+ * @beta
+ */
+export type ReactNode = any;
+//# sourceMappingURL=react-types.d.ts.map

package/lib/react-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-types.d.ts","sourceRoot":"","sources":["../src/react-types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;CAC1C,CAAC,gBAAgB,CAAC,CAAC;AAEpB;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,GAAG,CAAC"}

package/lib/react-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=react-types.js.map

package/lib/react-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-types.js","sourceRoot":"","sources":["../src/react-types.ts"],"names":[],"mappings":""}

package/lib/search.d.ts

@@ -0,0 +1,49 @@
+import { Entity } from './model';
+/**
+ * @beta
+ * Interface representing the properties for the SearchXperience component.
+ */
+export interface SearchXperienceProps {
+    /** The title of the search experience. */
+    title?: string | undefined;
+    /** The default concepts for the search experience. */
+    defaultConcept?: string[] | undefined;
+    /** Whether to disable the concept selector. */
+    disableConceptSelector?: boolean | undefined;
+    /** The task ID associated with the search experience. */
+    taskID?: string;
+    /** The default search fields for the search experience. */
+    defaultSearchFields?: {
+        entity_label?: string;
+        os_textsearchfield?: string;
+    };
+}
+/**
+ * @beta
+ * Interface representing the properties for the SearchXperienceModal component, extending SearchXperienceProps.
+ */
+export interface SearchXperienceModalProps extends SearchXperienceProps {
+    /** Whether the modal is open. */
+    open?: boolean | undefined;
+    /**
+     * Callback function to be called when the modal is closed.
+     * @param entities - The entities selected in the search experience.
+     * @returns A void or undefined.
+     */
+    onClose: (entities: Entity[]) => void | undefined;
+}
+/**
+ * @beta
+ * Interface representing the properties for the Search component.
+ */
+export interface SearchProps {
+    /**
+     * the query string to search for.
+     */
+    q?: string;
+    /**
+     * the label for the submit button.
+     */
+    submitButtonLabel?: string;
+}
+//# sourceMappingURL=search.d.ts.map

package/lib/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/lib/search.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=search.js.map

package/lib/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":""}

package/lib/semantic.d.ts

@@ -0,0 +1,40 @@
+import { ConceptName } from './model';
+/**
+ * @beta
+ * Type representing the properties for a template binding.
+ */
+export interface SemanticBindingProps {
+    /** The concept to which the binding applies */
+    concept: string;
+    /** The priority for the template, lower value means higher priority */
+    priority?: number;
+    /** Whether the result should be shown in large mode by default */
+    maximized?: boolean;
+    /** Other properties */
+    [key: string]: any;
+}
+/**
+ * @beta
+ * Type representing a semantic binding type.
+ */
+export type SemanticBindingType = 'record_viewer' | string;
+/**
+ * @beta
+ * Type representing a template binding.
+ */
+export type SemanticBinding = {
+    /** The concept to which the binding applies */
+    concept: ConceptName;
+    /** the role for which the binding applies */
+    role?: SemanticBindingType;
+    /** The actual binding properties */
+    props?: SemanticBindingProps;
+};
+/**
+ * @beta
+ * Type representing multiple semantic bindings.
+ */
+export type SemanticBindings = {
+    [k in SemanticBindingType]: (ConceptName | SemanticBinding)[];
+};
+//# sourceMappingURL=semantic.d.ts.map

package/lib/semantic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic.d.ts","sourceRoot":"","sources":["../src/semantic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uBAAuB;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,MAAM,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,+CAA+C;IAC/C,OAAO,EAAE,WAAW,CAAC;IACrB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,oCAAoC;IACpC,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAC5B,CAAC,IAAI,mBAAmB,GAAG,CAAC,WAAW,GAAG,eAAe,CAAC,EAAE;CAC9D,CAAC"}

package/lib/semantic.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=semantic.js.map

package/lib/semantic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic.js","sourceRoot":"","sources":["../src/semantic.ts"],"names":[],"mappings":""}

package/lib/styling.d.ts

@@ -0,0 +1,87 @@
+import { Desktop } from './desktop';
+import { EventEmitterType } from './event';
+import { EdgeSpec, GraphSpec } from './graph';
+import { Entity } from './model';
+import { Ontology } from './ontology';
+type TODO = any;
+/**
+ * @beta
+ * Type representing a styler with methods for getting G6 node and edge styles.
+ */
+export type Styler = {
+    /**
+     * Gets the style for a G6 node.
+     * @param e - The entity for which to get the node style.
+     * @param curr - The current style.
+     * @returns A promise that resolves to the new style.
+     */
+    getG6NodeStyle?: (e: Entity, curr: TODO) => Promise<TODO>;
+    /**
+     * Gets the style for a G6 edge.
+     * @param e - The edge specification for which to get the edge style.
+     * @param curr - The current style.
+     * @returns A promise that resolves to the new style.
+     */
+    getG6EdgeStyle?: (e: EdgeSpec, curr: TODO) => Promise<TODO>;
+};
+/**
+ * @beta
+ * Interface representing the context for a styler.
+ */
+export interface StylerContext {
+    /** The graph specification. */
+    graph: GraphSpec;
+    /** The selected graph specification. */
+    selected: GraphSpec;
+    /** The ontology API instance. */
+    OntologyAPI: Ontology;
+    /** The desktop API instance. */
+    DesktopAPI: Desktop;
+    /** The event emitter instance. */
+    ee: EventEmitterType;
+    /** The event topic prefix. */
+    eventTopicPrefix: string;
+    /**
+     * @beta
+     * Callback function to be called when the task is complete.
+     * @param x - The styler instance.
+     */
+    onTaskComplete?: (x: Styler) => void;
+    /** Callback function to be called when the task is canceled. */
+    onTaskCanceled?: () => void;
+    /** The task ID associated with the styler. */
+    taskID?: string;
+}
+/**
+ * @beta
+ * Type representing a function that produces a styler.
+ * @param context - The context for the styler.
+ * @returns A promise that resolves to the styler.
+ */
+export type StylerProducer = (context: StylerContext) => Promise<Styler>;
+/**
+ * @beta
+ * Type representing an option for a styler.
+ */
+export type StylerOption = {
+    /** The name of the styler option. */
+    name: string;
+    /** The description of the styler option. */
+    description: string;
+};
+/**
+ * @beta
+ * Type representing the configuration for a styler.
+ */
+export type StylerConfig = StylerOption & {
+    /** The name of the styler configuration. */
+    name: string;
+    /** The description of the styler configuration. */
+    description: string;
+    /** The initialization function for the styler. */
+    init: StylerProducer;
+    /** The optional destroy function for the styler. */
+    destroy?: () => Promise<void>;
+};
+export {};
+//# sourceMappingURL=styling.d.ts.map

package/lib/styling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../src/styling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,KAAK,IAAI,GAAG,GAAG,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,iCAAiC;IACjC,WAAW,EAAE,QAAQ,CAAC;IACtB,gCAAgC;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,kCAAkC;IAClC,EAAE,EAAE,gBAAgB,CAAC;IACrB,8BAA8B;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,gEAAgE;IAChE,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IACxC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B,CAAC"}

package/lib/styling.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=styling.js.map

package/lib/styling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"styling.js","sourceRoot":"","sources":["../src/styling.ts"],"names":[],"mappings":""}

package/lib/templates.d.ts

@@ -0,0 +1,110 @@
+import { ModalProps } from 'antd';
+import { ReactCssProperties } from './react-types';
+import { SemanticBinding } from './semantic';
+/**
+ * @beta
+ * Type representing the possible template types.
+ */
+export type TemplateType = 'nunjucks' | 'javascript';
+/**
+ * @beta
+ * Type representing the possible template variants.
+ */
+export type TemplateVariant = 'antd';
+/**
+ * @beta
+ * Type representing the metadata for a template.
+ */
+export type TemplateMetadata = {
+    /** The name of the template. */
+    name: string;
+    /** The description of the template. */
+    description: string;
+    /** The concepts associated with the template. */
+    concepts: string[];
+    /** The type of the template. */
+    type: TemplateType;
+    /** The layout of the template. */
+    layout: string;
+    /** The variant of the template. */
+    variant: TemplateVariant;
+    /** Optional blurhash for the template. */
+    blurhash?: string;
+    /** The parameter names required by the template. */
+    parameterNames: string[];
+    /** Optional CSS properties for the template. */
+    style?: ReactCssProperties;
+    /** Whether the template renders multiple records. */
+    rendersMultipleRecords?: boolean;
+    /** Whether the template is an app. */
+    isApp?: boolean;
+    /** details for semantic bindings. These can be app-specific */
+    bindings?: SemanticBinding[];
+};
+/**
+ * @beta
+ * Type representing a custom template, extending TemplateMetadata.
+ */
+export type CustomTemplate = TemplateMetadata & {
+    /** The template content. */
+    template: string;
+};
+/**
+ * @beta
+ * Type representing a saved template, extending CustomTemplate.
+ */
+export type SavedTemplate = CustomTemplate & {
+    /** The unique identifier for the entity. */
+    os_entity_uid: string;
+    /** The workspace to which the template belongs. */
+    os_workspace: string;
+};
+/**
+ * @beta
+ * Type representing the properties for a custom template iframe.
+ */
+export type CustomTemplateIframeProps = {
+    /** The template to be rendered in the iframe. */
+    template: CustomTemplate | SavedTemplate | string;
+    /** The context for the template. */
+    context: any;
+    /** Whether to enable debug mode. */
+    debug?: boolean;
+    /**
+     * Callback function to be called on error.
+     * @param err - The error object.
+     */
+    onError?: (err: {
+        message: string;
+    }) => void;
+    /** The width of the iframe. */
+    width?: number | string;
+    /** The height of the iframe. */
+    height?: number | string;
+    /** Optional CSS properties for the iframe. */
+    style?: ReactCssProperties;
+    /** Whether the iframe should take the full width. */
+    fullWidth?: boolean;
+};
+/**
+ * @beta
+ * Type representing the properties for a modal template, extending CustomTemplateIframeProps.
+ */
+export type ModalTemplateProps = CustomTemplateIframeProps & {
+    /** Optional properties for the modal. */
+    modalProps?: ModalProps;
+    /** Whether the modal is open. */
+    isModalOpen: boolean;
+    /**
+     * Function to set the open state of the modal.
+     * @param open - The new open state of the modal.
+     */
+    setIsModalOpen: (open: boolean) => void;
+    /** Callback function to be called on completion. */
+    onComplete?: () => void;
+    /** Callback function to be called on cancel. */
+    onCancel?: () => void;
+    /** The task ID associated with the modal. */
+    taskID?: string;
+};
+//# sourceMappingURL=templates.d.ts.map

package/lib/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gCAAgC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,4CAA4C;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/lib/templates.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=templates.js.map

package/lib/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":""}