@octostar/platform-types 0.2.0 → 0.2.2

package/lib/workspace.d.ts

@@ -0,0 +1,181 @@
+import { AddListener, Callback, Unsubscribe } from './callback';
+import { Entity, OsTag, WorkspaceItem, WorkspaceItems, WorkspaceRelationship } from './model';
+/**
+ * @beta
+ * Type representing information about a tag.
+ */
+export type TagInfo = {
+    /** The tag string. */
+    tag: string;
+    /** The workspace associated with the tag. */
+    os_workspace: string;
+    /** The count of entities associated with the tag. */
+    count: number;
+    /** A sample of entities associated with the tag. */
+    sample: Entity[];
+    /** The entity representing the tag. */
+    entity: OsTag;
+};
+/**
+ * @beta
+ * Type representing a tag with its associated relationship.
+ */
+export type TagWithRelationship = {
+    /** The workspace relationship associated with the tag. */
+    os_workspace_relationship: WorkspaceRelationship;
+    /** The tag entity. */
+    os_tag: OsTag;
+};
+/**
+ * @beta
+ * Type representing a permission for a workspace item.
+ */
+export type Permission = WorkspaceItem & {
+    /** The username associated with the permission. */
+    os_username?: string;
+    /** The permission value. */
+    os_permission: number;
+    /** The role associated with the permission. */
+    os_role?: string;
+};
+/**
+ * @beta
+ * Enum representing the possible values for workspace permissions.
+ */
+export declare enum WorkspacePermissionValue {
+    None = 0,
+    Read = 1,
+    Write = 2,
+    Admin = 4
+}
+/**
+ * @beta
+ * Type representing a workspace permission.
+ */
+export type WorkspacePermission = {
+    /** The value of the permission. */
+    value: WorkspacePermissionValue;
+    /** The label for the permission. */
+    label: string;
+};
+/**
+ * @beta
+ * Type representing information about records in a workspace.
+ */
+export type WorkspaceRecordInfo = {
+    /** The concept associated with the records. */
+    concept: string;
+    /** The count of records. */
+    count: number;
+    /** The last updated timestamp for the records. */
+    max_last_updated: string;
+    /** The entities associated with the records. */
+    entities: Entity[];
+};
+/**
+ * @beta
+ * Type representing a collection of workspace records.
+ */
+export type WorkspaceRecords = {
+    [key: string]: WorkspaceRecordInfo;
+};
+/**
+ * @beta
+ * Type representing a workspace.
+ */
+export type Workspace = {
+    /** The workspace item. */
+    workspace: WorkspaceItem;
+    /** The items in the workspace. */
+    items: WorkspaceItems;
+    /** Optional records in the workspace. */
+    workspace_records?: WorkspaceRecords;
+    /** Optional tags in the workspace. */
+    tags?: TagInfo[];
+    /** Optional permission for the workspace. */
+    permission?: WorkspacePermission;
+    /** Whether the workspace is active. */
+    isActive?: boolean;
+};
+/**
+ * @beta
+ * Type representing a UUID.
+ */
+export type uuid = string;
+/**
+ * @beta
+ * Type representing a workspace identifier, which can be a UUID or a workspace item.
+ * @template T - The type of the workspace item.
+ */
+export type WorkspaceIdentifier<T = any> = uuid | WorkspaceItem<T>;
+/**
+ * @beta
+ * Type representing a workspace item identifier, which is the same as a workspace identifier.
+ * @template T - The type of the workspace item.
+ */
+export type WorkspaceItemIdentifier<T = any> = WorkspaceIdentifier<T>;
+/**
+ * @beta
+ * Type representing a workspace record with its relationships.
+ */
+export type WorkspaceRecordWithRelationships = {
+    /** The workspace item. */
+    entity: WorkspaceItem;
+    /** The name of the relationship. */
+    relationship_name?: string;
+    /** The relationships associated with the workspace record. */
+    relationships?: [WorkspaceRecordWithRelationships];
+};
+/**
+ * @beta
+ * Interface representing a workspace change emitter.
+ */
+export interface WorkspaceChangeEmitter {
+    /**
+     * Subscribes to changes for a given workspace.
+     * @param ws - The workspace identifier.
+     * @param callback - The callback to invoke on changes.
+     * @returns A promise that resolves to an unsubscribe function.
+     */
+    onWorkspaceChanged: (ws: WorkspaceIdentifier, callback: Callback<Workspace>) => Promise<Unsubscribe>;
+    /**
+     * Subscribes to changes for a given workspace item.
+     * @param item - The workspace item identifier.
+     * @param callback - The callback to invoke on changes.
+     * @returns A promise that resolves to an unsubscribe function.
+     */
+    onWorkspaceItemChanged: (item: WorkspaceItemIdentifier, callback: Callback<WorkspaceItem>) => Promise<Unsubscribe>;
+    /**
+     * Subscribes to changes for the currently open workspaces.
+     * @param callback - The callback to invoke with the current open workspaces.
+     * @returns A promise that resolves to an unsubscribe function.
+     */
+    onOpenWorkspacesChanged: AddListener<Workspace[]>;
+}
+/**
+ * @beta
+ * Type representing settings for a workspace.
+ */
+export type WorkspaceSettings = {
+    /** Whether the workspace is the master workspace. */
+    isMaster?: boolean;
+    /** The icon for the workspace. */
+    os_icon?: string;
+};
+/**
+ * @beta
+ * Type representing a workspace item with its settings.
+ */
+export type OsWorkspacePickerProps = {
+    onChange: (value: string) => void;
+    desktop: any;
+    openWorkspacesOnly?: boolean;
+    defaultWorkspace?: string;
+    checkActiveWorkspace?: boolean;
+    permissions?: WorkspacePermissionValue;
+    dashboardOptions?: {
+        value: string;
+        label: string;
+    }[];
+};
+//# sourceMappingURL=workspace.d.ts.map

package/lib/workspace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../src/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EACL,MAAM,EACN,KAAK,EACL,aAAa,EACb,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,uCAAuC;IACvC,MAAM,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,0DAA0D;IAC1D,yBAAyB,EAAE,qBAAqB,CAAC;IACjD,sBAAsB;IACtB,MAAM,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG;IACvC,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,oBAAY,wBAAwB;IAClC,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,mCAAmC;IACnC,KAAK,EAAE,wBAAwB,CAAC;IAChC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,gBAAgB,EAAE,MAAM,CAAC;IACzB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,0BAA0B;IAC1B,SAAS,EAAE,aAAa,CAAC;IACzB,kCAAkC;IAClC,KAAK,EAAE,cAAc,CAAC;IACtB,yCAAyC;IACzC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,sCAAsC;IACtC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,GAAG,GAAG,IAAI,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAC;IACtB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8DAA8D;IAC9D,aAAa,CAAC,EAAE,CAAC,gCAAgC,CAAC,CAAC;CACpD,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,kBAAkB,EAAE,CAClB,EAAE,EAAE,mBAAmB,EACvB,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,KAC1B,OAAO,CAAC,WAAW,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,sBAAsB,EAAE,CACtB,IAAI,EAAE,uBAAuB,EAC7B,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,KAC9B,OAAO,CAAC,WAAW,CAAC,CAAC;IAE1B;;;;OAIG;IACH,uBAAuB,EAAE,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,GAAG,CAAC;IACb,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,WAAW,CAAC,EAAE,wBAAwB,CAAC;IACvC,gBAAgB,CAAC,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC"}

package/lib/workspace.js

@@ -0,0 +1,12 @@
+/**
+ * @beta
+ * Enum representing the possible values for workspace permissions.
+ */
+export var WorkspacePermissionValue;
+(function (WorkspacePermissionValue) {
+    WorkspacePermissionValue[WorkspacePermissionValue["None"] = 0] = "None";
+    WorkspacePermissionValue[WorkspacePermissionValue["Read"] = 1] = "Read";
+    WorkspacePermissionValue[WorkspacePermissionValue["Write"] = 2] = "Write";
+    WorkspacePermissionValue[WorkspacePermissionValue["Admin"] = 4] = "Admin";
+})(WorkspacePermissionValue || (WorkspacePermissionValue = {}));
+//# sourceMappingURL=workspace.js.map

package/lib/workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../src/workspace.ts"],"names":[],"mappings":"AAkDA;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,uEAAQ,CAAA;IACR,uEAAQ,CAAA;IACR,yEAAS,CAAA;IACT,yEAAS,CAAA;AACX,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC"}

package/package.json

@@ -1,16 +1,6 @@
 {
   "name": "@octostar/platform-types",
-  "version": "0.2.0",
-  "exports": {
-    ".": {
-      "import": "./lib/index.js",
-      "require": "./lib/index.js",
-      "types": "./dist/platform-types.d.ts"
-    }
-  },
-  "main": "lib/index.js",
-  "module": "lib/index.js",
-  "types": "dist/platform-types.d.ts",
+  "version": "0.2.2",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",
@@ -23,7 +13,18 @@
   },
   "license": "MIT",
   "author": "",
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./dist/platform-types.d.ts"
+    }
+  },
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "dist/platform-types.d.ts",
   "files": [
+    "lib",
     "dist/platform-types.d.ts",
     "dist/docs"
   ],
@@ -52,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "babd67d2a916eafbfa65778b1f403745964f69a7"
+  "gitHead": "4bd87c9273e0930c3f3abc6e15ab32def471ad46"
 }