@jsm-mit/rabbit-motoko-package 0.1.9 → 0.1.11

package/README.md

@@ -0,0 +1,118 @@
+# Rabbit Motoko Package
+
+A TypeScript library for interacting with the Rabbit Motoko actor on the Internet Computer (IC) platform. Simplifies interaction with the Rabbit task queuing system through a convenient wrapper around @dfinity/agent.
+
+## Installation
+
+```bash
+npm install @jsm-mit/rabbit-motoko-package
+```
+
+## Usage
+
+### Initialization
+
+```typescript
+import { RabbitMotokoActor } from '@jsm-mit/rabbit-motoko-package';
+
+const canisterId = 'your-canister-id';
+const rabbitActor = new RabbitMotokoActor(canisterId);
+```
+
+### Adding a task
+
+```typescript
+const taskId = await rabbitActor.addTask({
+  channel: 'my-channel',
+  taskType: 'process-data',
+  payload: 'task payload data'
+});
+console.log('Task added with ID:', taskId);
+```
+
+### Getting available tasks
+
+```typescript
+const availableTaskIds = await rabbitActor.getAvailableTaskIds('my-channel');
+console.log('Available tasks:', availableTaskIds);
+```
+
+### Claiming a task
+
+```typescript
+const task = await rabbitActor.claimTask({
+  taskId: 123n,
+  workerId: 'worker-1'
+});
+
+if (task.length > 0) {
+  console.log('Task claimed:', task[0]);
+} else {
+  console.log('Task not available');
+}
+```
+
+### Completing a task
+
+```typescript
+const success = await rabbitActor.completeTask({
+  taskId: 123n,
+  result: 'task completed successfully'
+});
+
+if (success) {
+  console.log('Task completed successfully');
+}
+```
+
+### Getting all tasks
+
+```typescript
+const allTasks = await rabbitActor.getTasks();
+console.log('All tasks:', allTasks);
+```
+
+### Agent synchronization
+
+In case of time/certificate issues:
+
+```typescript
+await rabbitActor.sync();
+```
+
+## API
+
+### `RabbitMotokoActor` Class
+
+#### Constructor
+- `new RabbitMotokoActor(canisterId: string)` - Creates a new instance with the provided canister ID
+
+#### Public Methods
+
+- `sync(): Promise<void>` - Synchronizes the agent time with the IC network
+- `addTask(args: AddTaskArgs): Promise<bigint>` - Adds a new task to the queue
+- `claimTask(args: ClaimTaskArgs): Promise<[] | [Task]>` - Claims a task for a worker
+- `completeTask(args: CompleteTaskArgs): Promise<boolean>` - Completes a claimed task
+- `getAvailableTaskIds(channel: string): Promise<bigint[]>` - Gets IDs of available tasks in a channel
+- `getTasks(): Promise<Task[]>` - Gets a list of all tasks
+
+## Types
+
+The library uses types generated from the Rabbit Motoko canister:
+- `AddTaskArgs` - Arguments for adding a task
+- `ClaimTaskArgs` - Arguments for claiming a task
+- `CompleteTaskArgs` - Arguments for completing a task
+- `Task` - Task structure
+
+## Requirements
+
+- Node.js 16+
+- TypeScript 4.5+
+
+## License
+
+ISC
+
+## Author
+
+@jsm-mit

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { RabbitMotokoActor } from "./rabbit-motoko-actor.js";
+export type { AddTaskArgs, ClaimTaskArgs, CompleteTaskArgs, Task } from '../declarations/rabbit-motoko-backend/rabbit-motoko-backend.did.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,oEAAoE,CAAC"}

package/dist/rabbit-motoko-actor.d.ts

@@ -1,10 +1,11 @@
+import { Identity } from "@icp-sdk/core/agent";
 import { AddTaskArgs, ClaimTaskArgs, CompleteTaskArgs, Task } from "../declarations/rabbit-motoko-backend/rabbit-motoko-backend.did.js";
 export declare class RabbitMotokoActor {
     private readonly canisterId;
     private readonly host;
     private actor;
     private agent;
-    constructor(canisterId: string);
+    constructor(canisterId: string, identity?: Identity);
     private initActor;
     private setupAgent;
     private checkError;

package/dist/rabbit-motoko-actor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rabbit-motoko-actor.d.ts","sourceRoot":"","sources":["../src/rabbit-motoko-actor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,oEAAoE,CAAC;AAGlJ,qBAAa,iBAAiB;IAKd,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6B;IAClD,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,KAAK,CAAY;gBAEI,UAAU,EAAE,MAAM;IAe/C,OAAO,CAAC,SAAS;YAOH,UAAU;YAWV,UAAU;IAQX,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IASlC;;OAEG;IACU,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAUxD;;OAEG;IACU,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAUjE;;OAEG;IACU,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUnE;;OAEG;IACU,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAUpE;;OAEG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;CAS3C"}
+{"version":3,"file":"rabbit-motoko-actor.d.ts","sourceRoot":"","sources":["../src/rabbit-motoko-actor.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEhF,OAAO,EAAY,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,oEAAoE,CAAC;AAGlJ,qBAAa,iBAAiB;IAKd,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6B;IAClD,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,KAAK,CAAY;gBAEI,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ;IAcpE,OAAO,CAAC,SAAS;YAOH,UAAU;YAWV,UAAU;IAQX,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IASlC;;OAEG;IACU,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAUxD;;OAEG;IACU,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAUjE;;OAEG;IACU,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUnE;;OAEG;IACU,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAUpE;;OAEG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;CAS3C"}

package/dist/rabbit-motoko-actor.js

@@ -1,14 +1,13 @@
 import { Actor, HttpAgent } from "@icp-sdk/core/agent";
 import { idlFactory } from "../declarations/rabbit-motoko-backend/index.js";
 export class RabbitMotokoActor {
-    constructor(canisterId) {
+    constructor(canisterId, identity) {
         this.canisterId = canisterId;
         this.host = "https://icp0.io";
         // 1. Tworzymy agenta
         this.agent = new HttpAgent({
             host: this.host,
-            // Opcjonalnie: można zwiększyć margines akceptacji czasu (retryDelay), 
-            // ale syncTime() jest skuteczniejszym rozwiązaniem.
+            identity,
         });
         // 2. Inicjalizujemy aktora
         this.initActor();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jsm-mit/rabbit-motoko-package",
-    "version": "0.1.9",
+    "version": "0.1.11",
     "description": "Wrapper TypeScript package for Rabbit Motoko IC actor using @dfinity/agent.",
     "license": "ISC",
     "author": "",
@@ -21,6 +21,7 @@
         "build": "tsc --build",
         "clean": "rm -rf dist",
         "prepare": "npm run build",
+        "publish": "npm publish --access public",
         "test": "echo \"Error: no test specified\" && exit 1"
     },
     "devDependencies": {