@jsm-mit/sultana-assets-rust-package 0.3.0 → 0.3.1

package/README.md

@@ -34,7 +34,7 @@ One class per part of the canister:
 | `AssetsRustUploadsActor` | chunked session, single-shot upload, `uploadBytesAsyncUnsafe` | any signed-in caller |
 | `AssetsRustSalonActor` | `upload_image`, `delete_salon_asset`, transcoding and render reservations | the salon's owner — core decides |
 | `AssetsRustWorkerActor` | system upload of a transcoded result under a reserved id | listed transcoding workers |
-| `AssetsRustAssetsActor` | `get_asset_info`, `list_assets`, `http_request`, `assetUrl` | anybody |
+| `AssetsRustAssetsActor` | `get_asset_info`, `list_assets`, `http_request`, `assetUrl` | anybody; `list_assets` only the canister's controllers and the core seat |
 | `AssetsRustAvatarActor` | `upload_my_avatar`, `delete_my_avatar` (own avatar only, profile required — core `isUser` —, no quota; 64 KB / 512 px, re-encoded as JPEG), `get_avatar`, `/avatar/<principal>`, `avatarUrl` | writes: the caller for themselves; reads: anybody |
 
 Every method is `…AsyncUnsafe` and throws one of three errors, like the other wrapper
@@ -57,7 +57,8 @@ types are exported too, and `./declarations/*` gives the generated files.
 `src/` is browser-safe — the same package serves the biz panel, the playground and the
 transcoding worker.
 
-Scripts: `build`, `typecheck`, `sync-declarations`, `test-suite`, `test-smoke`, `test-upgrade`, `redeploy`, `sandbox`
+Scripts: `build`, `typecheck`, `sync-declarations`, `test-suite`, `test-smoke`, `test-upgrade`,
+`test-suite-local`, `test-smoke-local`, `test-upgrade-local`, `redeploy`, `sandbox`
 (an interactive console: `npm run sandbox -- <canister-id>`, caller from `IDENTITY_PEM` in
 `.env.sandbox` or anonymous), `stamp-canister`, `publish-public`. See `CLAUDE.md` for who runs what.
 
@@ -73,6 +74,12 @@ read per domain (worker list, a few-byte single-shot upload read back over HTTP,
 result, a salon upload refused by the stand-in core), one replication wait, ≈ 30 s.
 `publish-public` runs it too.
 
+The `-local` variants (`npm run test-suite-local`, `test-smoke-local`, `test-upgrade-local`) run
+the same entry points on the LOCAL replica — no cycles, no lease. `scripts/local-canister.sh`
+builds `../sultana-assets-rust` with cargo and reinstalls it into a canister of the dfx project
+in `local/` (its id stays under `local/.dfx`); the upgrade test upgrades that canister. The
+local replica must run (`dfx start --background`); the scripts never start or stop it.
+
 What the suite covers: the core seat and the worker list; chunked and single-shot uploads
 with every owner and size check; reads, HTTP 200/206/404, certification header and
 streaming; the worker's system upload with a poster; `delete_asset` taking the thumb along;
@@ -85,7 +92,8 @@ the suite never touches it.
 
 Bump the version by hand, commit, push, then `npm run publish-public`. It refuses unless this
 repo and `../sultana-assets-rust` are on a clean, pushed `master` and the version is new on
-npm; it reinstalls the canister's master into `short-living` (lease 2), checks that its
+npm; it reinstalls the canister's master into the canister on the LOCAL replica
+(`scripts/local-canister.sh`; the replica must run), checks that its
 `candid:service` equals `declarations/sultana-assets-rust/sultana-assets-rust.did` as dfx
 rewrites it (the hand-written .did is normalized by a local `dfx build --check` first), runs
 the smoke test (`tests/test-smoke.ts`) on that same deploy, stamps

package/dist/actor-base.d.ts

@@ -25,10 +25,13 @@ export declare class ActorBase {
     protected host: string;
     protected actor: ActorSubclass<_SERVICE>;
     protected agent: HttpAgent;
+    private ready;
     /**
      * @param canisterId - The sultana-assets-rust canister to talk to.
      * @param identity - The caller; left out = anonymous (enough for the reads).
-     * @param host - The IC API host; default https://icp0.io.
+     * @param host - The IC API host; default https://icp0.io. A local replica
+     *   (`http://127.0.0.1:4943`) works too: for a local host — and only then — the agent
+     *   fetches the replica's root key before the first call.
      */
     constructor(canisterId: string, identity?: Identity | undefined, host?: string);
     private initAgentAndActor;

package/dist/actor-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"actor-base.d.ts","sourceRoot":"","sources":["../src/actor-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAS,MAAM,qBAAqB,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gEAAgE,CAAC;AAG/F,sFAAsF;AACtF,MAAM,WAAW,SAAS;IACtB,yFAAyF;IACzF,QAAQ,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;CACrB;AAKD;;;;;;;;;GASG;AACH,qBAAa,SAAS;IASN,SAAS,CAAC,UAAU,EAAE,MAAM;IAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,QAAQ;IAAE,SAAS,CAAC,IAAI,EAAE,MAAM;IAR/F,SAAS,CAAC,KAAK,EAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1C,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAE5B;;;;OAIG;gBACmB,UAAU,EAAE,MAAM,EAAY,QAAQ,CAAC,EAAE,QAAQ,YAAA,EAAY,IAAI,GAAE,MAAqB;IAI9G,OAAO,CAAC,iBAAiB;IAWzB;;;;OAIG;IACI,iBAAiB,IAAI,IAAI;IAIhC,iFAAiF;cACjE,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAqBpF,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IASpD,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;CAU1D"}
+{"version":3,"file":"actor-base.d.ts","sourceRoot":"","sources":["../src/actor-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAS,MAAM,qBAAqB,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gEAAgE,CAAC;AAG/F,sFAAsF;AACtF,MAAM,WAAW,SAAS;IACtB,yFAAyF;IACzF,QAAQ,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;CACrB;AASD;;;;;;;;;GASG;AACH,qBAAa,SAAS;IAYN,SAAS,CAAC,UAAU,EAAE,MAAM;IAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,QAAQ;IAAE,SAAS,CAAC,IAAI,EAAE,MAAM;IAX/F,SAAS,CAAC,KAAK,EAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1C,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,KAAK,CAAoC;IAEjD;;;;;;OAMG;gBACmB,UAAU,EAAE,MAAM,EAAY,QAAQ,CAAC,EAAE,QAAQ,YAAA,EAAY,IAAI,GAAE,MAAqB;IAI9G,OAAO,CAAC,iBAAiB;IAYzB;;;;OAIG;IACI,iBAAiB,IAAI,IAAI;IAIhC,iFAAiF;cACjE,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAuBpF,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IASpD,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;CAU1D"}

package/dist/actor-base.js

@@ -1,6 +1,9 @@
 import { HttpAgent, Actor } from "@icp-sdk/core/agent";
 import { idlFactory } from "../declarations/sultana-assets-rust/sultana-assets-rust.did.js";
 import { DEFAULT_HOST } from "./constants.js";
+function isLocalHost(host) {
+    return /^https?:\/\/(127\.0\.0\.1|localhost|\[::1\])(:\d+)?\/?$/.test(host);
+}
 // IC error code of an explicit trap (ic0.trap — every ic_cdk::trap and every Rust panic).
 const TRAP_ERROR_CODE = "IC0503";
 /**
@@ -19,10 +22,13 @@ export class ActorBase {
     host;
     actor;
     agent;
+    ready = Promise.resolve();
     /**
      * @param canisterId - The sultana-assets-rust canister to talk to.
      * @param identity - The caller; left out = anonymous (enough for the reads).
-     * @param host - The IC API host; default https://icp0.io.
+     * @param host - The IC API host; default https://icp0.io. A local replica
+     *   (`http://127.0.0.1:4943`) works too: for a local host — and only then — the agent
+     *   fetches the replica's root key before the first call.
      */
     constructor(canisterId, identity, host = DEFAULT_HOST) {
         this.canisterId = canisterId;
@@ -35,6 +41,7 @@ export class ActorBase {
             host: this.host,
             identity: this.identity,
         });
+        this.ready = isLocalHost(this.host) ? this.agent.fetchRootKey().then(() => undefined) : Promise.resolve();
         this.actor = Actor.createActor(idlFactory, {
             agent: this.agent,
             canisterId: this.canisterId,
@@ -50,6 +57,7 @@ export class ActorBase {
     }
     /** Runs one canister call and translates its failure (see the class comment). */
     async executeFunctionAsyncUnsafe(fnAsync) {
+        await this.ready;
         try {
             return await fnAsync();
         }

package/dist/actors/assets-actor.d.ts

@@ -1,6 +1,7 @@
 import { ActorBase } from "../actor-base.js";
 import type { AssetInfoView, HttpGetInput, HttpResponseView } from "../interfaces.js";
-/** Reads: what is stored and how it is served. All queries — anonymous callers are fine. */
+/** Reads: what is stored and how it is served. All queries — anonymous callers are fine,
+ * except `listAssetsAsyncUnsafe`: the canister's controllers and the core seat only. */
 export declare class AssetsRustAssetsActor extends ActorBase {
     /**
      * @param assetId - The asset.
@@ -13,7 +14,8 @@ export declare class AssetsRustAssetsActor extends ActorBase {
     getAssetInfoAsyncUnsafe(assetId: string): Promise<AssetInfoView | null>;
     /**
      * Every asset physically stored — the raw storage view, independent of any salon library:
-     * thumbnails, posters and orphans included.
+     * thumbnails, posters and orphans included. The canister's controllers and the core seat
+     * only; anybody else gets a CanisterError ("list_assets refused: controllers only").
      * @returns A Promise that resolves to every stored asset.
      * @throws CanisterError - The canister trapped.
      * @throws CallRefusedAtInspectionStage - The call was refused at the inspect stage.

package/dist/actors/assets-actor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assets-actor.d.ts","sourceRoot":"","sources":["../../src/actors/assets-actor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGtF,4FAA4F;AAC5F,qBAAa,qBAAsB,SAAQ,SAAS;IAChD;;;;;;;OAOG;IACU,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAKpF;;;;;;;OAOG;IACU,qBAAqB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAK9D;;;;;;;;;;OAUG;IACU,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,YAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYzG,0EAA0E;IACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAG3C"}
+{"version":3,"file":"assets-actor.d.ts","sourceRoot":"","sources":["../../src/actors/assets-actor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGtF;wFACwF;AACxF,qBAAa,qBAAsB,SAAQ,SAAS;IAChD;;;;;;;OAOG;IACU,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAKpF;;;;;;;;OAQG;IACU,qBAAqB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAK9D;;;;;;;;;;OAUG;IACU,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,YAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYzG,0EAA0E;IACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAG3C"}

package/dist/actors/assets-actor.js

@@ -1,7 +1,8 @@
 import { ActorBase } from "../actor-base.js";
 import { assetUrl } from "../constants.js";
 import { mapAssetInfoView, mapHttpResponseView } from "../mappers.js";
-/** Reads: what is stored and how it is served. All queries — anonymous callers are fine. */
+/** Reads: what is stored and how it is served. All queries — anonymous callers are fine,
+ * except `listAssetsAsyncUnsafe`: the canister's controllers and the core seat only. */
 export class AssetsRustAssetsActor extends ActorBase {
     /**
      * @param assetId - The asset.
@@ -17,7 +18,8 @@ export class AssetsRustAssetsActor extends ActorBase {
     }
     /**
      * Every asset physically stored — the raw storage view, independent of any salon library:
-     * thumbnails, posters and orphans included.
+     * thumbnails, posters and orphans included. The canister's controllers and the core seat
+     * only; anybody else gets a CanisterError ("list_assets refused: controllers only").
      * @returns A Promise that resolves to every stored asset.
      * @throws CanisterError - The canister trapped.
      * @throws CallRefusedAtInspectionStage - The call was refused at the inspect stage.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jsm-mit/sultana-assets-rust-package",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "Wrapper TypeScript package for the sultana-assets-rust canister: chunked and single-shot uploads, salon images and transcoding reservations, the worker upload path, reads and asset URLs.",
     "license": "ISC",
     "author": "",
@@ -28,6 +28,9 @@
         "test-suite": "bash scripts/run-tests.sh tests/test-suite.ts --lease 3",
         "test-smoke": "bash scripts/run-tests.sh tests/test-smoke.ts --lease 3",
         "test-upgrade": "bash scripts/run-tests.sh tests/test-upgrade.ts --lease 6",
+        "test-suite-local": "bash scripts/run-tests-local.sh tests/test-suite.ts",
+        "test-smoke-local": "bash scripts/run-tests-local.sh tests/test-smoke.ts",
+        "test-upgrade-local": "bash scripts/run-tests-local.sh tests/test-upgrade.ts",
         "redeploy": "bash scripts/redeploy.sh",
         "sandbox": "npx tsx sandbox/main.ts",
         "stamp-canister": "bash scripts/stamp-canister-commit.sh"
@@ -55,6 +58,6 @@
     "sultanaAssets": {
         "repo": "sultana-assets-rust",
         "repoUrl": "https://github.com/JSM-Sultana/sultana-assets-rust",
-        "commit": "7a2c7e96a4253f0203d9694c9200189f61044c85"
+        "commit": "d63f0d1ebcfa98c953ae7f68b5331e81966cec8b"
     }
 }