@krizaka/storage 0.0.0-stage → 0.2.0

package/dist/testkit.js

@@ -0,0 +1,44 @@
+// src/testkit.ts
+import { expect, it } from "vitest";
+var bytes = (...n) => new Uint8Array(n);
+function objectStoreContract(name, make) {
+  it(`${name}: stores a file and reads it back byte for byte`, async () => {
+    const store = await make();
+    await store.put("site/home/a.b1.png", bytes(1, 2, 3, 255), { contentType: "image/png" });
+    const got = await store.get("site/home/a.b1.png");
+    expect([...got.bytes]).toEqual([1, 2, 3, 255]);
+    expect(got.contentType).toBe("image/png");
+    expect(await store.head("site/home/a.b1.png")).toEqual({ key: "site/home/a.b1.png", size: 4 });
+  });
+  it(`${name}: answers null for a missing file, and deleting it twice is fine`, async () => {
+    const store = await make();
+    expect(await store.get("missing/file.txt")).toBeNull();
+    expect(await store.head("missing/file.txt")).toBeNull();
+    await store.put("x/y.txt", bytes(1), { contentType: "text/plain" });
+    await store.delete("x/y.txt");
+    await store.delete("x/y.txt");
+    expect(await store.get("x/y.txt")).toBeNull();
+  });
+  it(`${name}: overwrites a key`, async () => {
+    const store = await make();
+    await store.put("k/f.bin", bytes(1), { contentType: "application/octet-stream" });
+    await store.put("k/f.bin", bytes(9, 9), { contentType: "application/octet-stream" });
+    expect([...(await store.get("k/f.bin")).bytes]).toEqual([9, 9]);
+  });
+  it(`${name}: lists the files under a prefix, directories flattened, in key order`, async () => {
+    const store = await make();
+    for (const key of ["a/one.txt", "a/b/two.txt", "a/b/c/three.txt", "other/four.txt", "a-b/five.txt"]) await store.put(key, bytes(7), { contentType: "text/plain" });
+    expect((await store.list("a/")).map((f) => f.key)).toEqual(["a/b/c/three.txt", "a/b/two.txt", "a/one.txt"]);
+    expect((await store.list("a/b/")).map((f) => f.key)).toEqual(["a/b/c/three.txt", "a/b/two.txt"]);
+    expect(await store.list("nothing/")).toEqual([]);
+    expect((await store.list("a/o")).map((f) => f.key)).toEqual(["a/one.txt"]);
+  });
+  it(`${name}: refuses a key that climbs out, is empty or has a bad segment`, async () => {
+    const store = await make();
+    for (const key of ["../x.txt", "a/../b.txt", "/abs.txt", "a//b.txt", "a/b/", "", "a\\b.txt"]) await expect(store.put(key, bytes(1), { contentType: "text/plain" })).rejects.toMatchObject({ code: "STORAGE_BAD_KEY" });
+  });
+}
+export {
+  objectStoreContract
+};
+//# sourceMappingURL=testkit.js.map

package/dist/testkit.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/testkit.ts"],"sourcesContent":["import { expect, it } from \"vitest\";\n\nimport type { ObjectStore } from \"./port\";\n\nconst bytes = (...n: number[]) => new Uint8Array(n);\n\n/** What every `ObjectStore` adapter must do: the same behaviour behind the same port. `make` gives an empty store. */\nexport function objectStoreContract(name: string, make: () => ObjectStore | Promise<ObjectStore>) {\n  it(`${name}: stores a file and reads it back byte for byte`, async () => {\n    const store = await make();\n    await store.put(\"site/home/a.b1.png\", bytes(1, 2, 3, 255), { contentType: \"image/png\" });\n    const got = await store.get(\"site/home/a.b1.png\");\n    expect([...got!.bytes]).toEqual([1, 2, 3, 255]);\n    expect(got!.contentType).toBe(\"image/png\");\n    expect(await store.head(\"site/home/a.b1.png\")).toEqual({ key: \"site/home/a.b1.png\", size: 4 });\n  });\n\n  it(`${name}: answers null for a missing file, and deleting it twice is fine`, async () => {\n    const store = await make();\n    expect(await store.get(\"missing/file.txt\")).toBeNull();\n    expect(await store.head(\"missing/file.txt\")).toBeNull();\n    await store.put(\"x/y.txt\", bytes(1), { contentType: \"text/plain\" });\n    await store.delete(\"x/y.txt\");\n    await store.delete(\"x/y.txt\");\n    expect(await store.get(\"x/y.txt\")).toBeNull();\n  });\n\n  it(`${name}: overwrites a key`, async () => {\n    const store = await make();\n    await store.put(\"k/f.bin\", bytes(1), { contentType: \"application/octet-stream\" });\n    await store.put(\"k/f.bin\", bytes(9, 9), { contentType: \"application/octet-stream\" });\n    expect([...(await store.get(\"k/f.bin\"))!.bytes]).toEqual([9, 9]);\n  });\n\n  it(`${name}: lists the files under a prefix, directories flattened, in key order`, async () => {\n    const store = await make();\n    for (const key of [\"a/one.txt\", \"a/b/two.txt\", \"a/b/c/three.txt\", \"other/four.txt\", \"a-b/five.txt\"]) await store.put(key, bytes(7), { contentType: \"text/plain\" });\n    expect((await store.list(\"a/\")).map((f) => f.key)).toEqual([\"a/b/c/three.txt\", \"a/b/two.txt\", \"a/one.txt\"]);\n    expect((await store.list(\"a/b/\")).map((f) => f.key)).toEqual([\"a/b/c/three.txt\", \"a/b/two.txt\"]);\n    expect((await store.list(\"nothing/\"))).toEqual([]);\n    expect((await store.list(\"a/o\")).map((f) => f.key)).toEqual([\"a/one.txt\"]);\n  });\n\n  it(`${name}: refuses a key that climbs out, is empty or has a bad segment`, async () => {\n    const store = await make();\n    for (const key of [\"../x.txt\", \"a/../b.txt\", \"/abs.txt\", \"a//b.txt\", \"a/b/\", \"\", \"a\\\\b.txt\"]) await expect(store.put(key, bytes(1), { contentType: \"text/plain\" })).rejects.toMatchObject({ code: \"STORAGE_BAD_KEY\" });\n  });\n}\n"],"mappings":";AAAA,SAAS,QAAQ,UAAU;AAI3B,IAAM,QAAQ,IAAI,MAAgB,IAAI,WAAW,CAAC;AAG3C,SAAS,oBAAoB,MAAc,MAAgD;AAChG,KAAG,GAAG,IAAI,mDAAmD,YAAY;AACvE,UAAM,QAAQ,MAAM,KAAK;AACzB,UAAM,MAAM,IAAI,sBAAsB,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,aAAa,YAAY,CAAC;AACvF,UAAM,MAAM,MAAM,MAAM,IAAI,oBAAoB;AAChD,WAAO,CAAC,GAAG,IAAK,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;AAC9C,WAAO,IAAK,WAAW,EAAE,KAAK,WAAW;AACzC,WAAO,MAAM,MAAM,KAAK,oBAAoB,CAAC,EAAE,QAAQ,EAAE,KAAK,sBAAsB,MAAM,EAAE,CAAC;AAAA,EAC/F,CAAC;AAED,KAAG,GAAG,IAAI,oEAAoE,YAAY;AACxF,UAAM,QAAQ,MAAM,KAAK;AACzB,WAAO,MAAM,MAAM,IAAI,kBAAkB,CAAC,EAAE,SAAS;AACrD,WAAO,MAAM,MAAM,KAAK,kBAAkB,CAAC,EAAE,SAAS;AACtD,UAAM,MAAM,IAAI,WAAW,MAAM,CAAC,GAAG,EAAE,aAAa,aAAa,CAAC;AAClE,UAAM,MAAM,OAAO,SAAS;AAC5B,UAAM,MAAM,OAAO,SAAS;AAC5B,WAAO,MAAM,MAAM,IAAI,SAAS,CAAC,EAAE,SAAS;AAAA,EAC9C,CAAC;AAED,KAAG,GAAG,IAAI,sBAAsB,YAAY;AAC1C,UAAM,QAAQ,MAAM,KAAK;AACzB,UAAM,MAAM,IAAI,WAAW,MAAM,CAAC,GAAG,EAAE,aAAa,2BAA2B,CAAC;AAChF,UAAM,MAAM,IAAI,WAAW,MAAM,GAAG,CAAC,GAAG,EAAE,aAAa,2BAA2B,CAAC;AACnF,WAAO,CAAC,IAAI,MAAM,MAAM,IAAI,SAAS,GAAI,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAAA,EACjE,CAAC;AAED,KAAG,GAAG,IAAI,yEAAyE,YAAY;AAC7F,UAAM,QAAQ,MAAM,KAAK;AACzB,eAAW,OAAO,CAAC,aAAa,eAAe,mBAAmB,kBAAkB,cAAc,EAAG,OAAM,MAAM,IAAI,KAAK,MAAM,CAAC,GAAG,EAAE,aAAa,aAAa,CAAC;AACjK,YAAQ,MAAM,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,mBAAmB,eAAe,WAAW,CAAC;AAC1G,YAAQ,MAAM,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,mBAAmB,aAAa,CAAC;AAC/F,WAAQ,MAAM,MAAM,KAAK,UAAU,CAAE,EAAE,QAAQ,CAAC,CAAC;AACjD,YAAQ,MAAM,MAAM,KAAK,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC;AAAA,EAC3E,CAAC;AAED,KAAG,GAAG,IAAI,kEAAkE,YAAY;AACtF,UAAM,QAAQ,MAAM,KAAK;AACzB,eAAW,OAAO,CAAC,YAAY,cAAc,YAAY,YAAY,QAAQ,IAAI,UAAU,EAAG,OAAM,OAAO,MAAM,IAAI,KAAK,MAAM,CAAC,GAAG,EAAE,aAAa,aAAa,CAAC,CAAC,EAAE,QAAQ,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAAA,EACvN,CAAC;AACH;","names":[]}

package/package.json

@@ -1,6 +1,85 @@
 {
   "name": "@krizaka/storage",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Files behind one port for every Krizaka product: put with a content-hashed name, get, head, delete, list, signed and public URLs; adapters over an injected fetch for an HTTP object store and any S3-compatible bucket (Signature V4, no SDK), and a local folder; layout as data, bytes checked by magic number, limits passed in. The admin chooses the provider through settings.",
+  "keywords": [
+    "krizaka",
+    "storage",
+    "files",
+    "s3",
+    "http",
+    "cdn",
+    "upload"
+  ],
+  "homepage": "https://github.com/krizaka/krizaka-ts/tree/main/packages/storage",
+  "bugs": "https://github.com/krizaka/krizaka-ts/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/krizaka/krizaka-ts.git",
+    "directory": "packages/storage"
+  },
+  "license": "Apache-2.0",
+  "author": "Krizaka (https://www.krizaka.com)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./settings": {
+      "types": "./dist/settings.d.ts",
+      "import": "./dist/settings.js"
+    },
+    "./testkit": {
+      "types": "./dist/testkit.d.ts",
+      "import": "./dist/testkit.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "@types/pg": "^8.23.1",
+    "eslint": "^9.39.0",
+    "pg": "^8.23.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.11",
+    "zod": "^4.6.7",
+    "@krizaka/config": "^0.8.1"
+  },
+  "dependencies": {
+    "@krizaka/db": "^0.2.0",
+    "@krizaka/settings": "^0.5.0"
+  },
+  "peerDependencies": {
+    "vitest": ">=4",
+    "zod": ">=3.23"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsup",
+    "lint": "eslint . --max-warnings 0 && tsc --noEmit",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check": "pnpm run lint && pnpm run test && pnpm run build"
+  }
 }