@speckle/objectsender 1.0.0 → 1.0.1

package/dist/examples/browser/main.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { Base } from './utils/Base';
+
+export { Base };
+export type SendParams = {
+    serverUrl?: string;
+    projectId: string;
+    token: string;
+    logger?: {
+        log: (message: unknown) => void;
+        error: (message: unknown) => void;
+    };
+};
+export type SendResult = {
+    hash: string;
+    traversed: Record<string, unknown>;
+};
+/**
+ * Decomposes, serializes and sends to a speckle server a given object. Note, for objects to be detached, they need to have a 'speckle_type' property.
+ * @param object object to decompose, serialise and send to speckle
+ * @param parameters: server url, project id and token
+ * @returns the hash of the root object and the value of the root object
+ */
+export declare const send: (object: Base, { serverUrl, projectId, token, logger }: SendParams) => Promise<SendResult>;

package/dist/transports/ITransport.d.ts

@@ -0,0 +1,12 @@
+export interface ITransport {
+    /**
+     * Instructs the transport to write this object to its storage layer.
+     * @param serialisedObject
+     * @param size approximate objects size
+     */
+    write(serialisedObject: string, size: number): Promise<void>;
+    /**
+     * Flushes the buffer ensuring it is persisted to its storage layer.
+     */
+    flush(): Promise<void>;
+}

package/dist/transports/ServerTransport.d.ts

@@ -0,0 +1,18 @@
+import { ITransport } from './ITransport';
+import { IDisposable } from '../utils/IDisposable';
+
+/**
+ * Basic object sender to a speckle server
+ */
+export declare class ServerTransport implements ITransport, IDisposable {
+    buffer: string[];
+    maxSize: number;
+    currSize: number;
+    serverUrl: string;
+    projectId: string;
+    authToken: string;
+    constructor(serverUrl: string, projectId: string, authToken: string, maxSize?: number);
+    write(serialisedObject: string, size: number): Promise<void>;
+    flush(): Promise<void>;
+    dispose(): void;
+}

package/dist/utils/Base.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Basic 'Base'-like object from .NET. It will create a 'speckle_type' prop that defaults to the class' name. This can be overriden by providing yourself a 'speckle_type' property in the props argument of the constructor.
+ */
+export declare class Base implements Record<string, unknown> {
+    speckle_type: string;
+    constructor(props?: Record<string, unknown>);
+    [x: string]: unknown;
+}

package/dist/utils/IDisposable.d.ts

@@ -0,0 +1,3 @@
+export interface IDisposable {
+    dispose: () => void;
+}

package/dist/utils/Serializer.d.ts

@@ -0,0 +1,21 @@
+import { ITransport } from '../transports/ITransport';
+import { Base } from './Base';
+import { IDisposable } from './IDisposable';
+
+export declare class Serializer implements IDisposable {
+    #private;
+    chunkSize: number;
+    detachLineage: boolean[];
+    lineage: string[];
+    familyTree: Record<string, Record<string, number>>;
+    closureTable: Record<string, unknown>;
+    transport: ITransport | null;
+    uniqueId: number;
+    hashingFunction: (s: string) => string;
+    constructor(transport: ITransport, chunkSize?: number, hashingFunction?: (s: string) => string);
+    write(obj: Base): Promise<{
+        hash: string;
+        traversed: Record<string, unknown>;
+    }>;
+    dispose(): void;
+}

package/dist/utils/Sha1.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Basic hashing function, to avoid dependencies and crazy build processes
+ * @param msg
+ * @returns
+ */
+export declare function SHA1(msg: string): string;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@speckle/objectsender",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Simple API helper to serialize and send objects to the server.",
   "type": "module",
   "main": "dist/objectsender.cjs",
   "module": "dist/objectsender.js",
   "homepage": "https://speckle.systems",
+  "types": "./dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/specklesystems/speckle-server.git",
@@ -41,12 +42,19 @@
     "eslint-config-prettier": "^9.1.0",
     "prettier": "^3.3.2",
     "typescript": "^5.2.2",
-    "vite": "^5.2.0"
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1"
   },
   "exports": {
     ".": {
-      "import": "./dist/objectsender.js",
-      "require": "./dist/objectsender.cjs"
+      "import": {
+        "default": "./dist/objectsender.js",
+        "types": "./dist/index.d.ts"
+      },
+      "require": {
+        "default": "./dist/objectsender.cjs",
+        "types": "./dist/index.d.ts"
+      }
     }
   },
   "imports": {

package/vite.config.js

@@ -1,6 +1,7 @@
 import pkg from './package.json'
 import { defineConfig } from 'vite'
 import { resolve } from 'path'
+import dts from 'vite-plugin-dts'
 
 export default defineConfig({
   build: {
@@ -14,5 +15,6 @@ export default defineConfig({
     rollupOptions: {
       external: Object.keys(pkg.dependencies || {})
     }
-  }
+  },
+  plugins: [dts()]
 })