@krizaka/storage 0.0.0-stage → 0.3.0

package/dist/where-DKtS1O5l.d.ts

@@ -0,0 +1,71 @@
+/**
+ * The country of each provider region (data: a new region is a line here, one table for every product, ADR-010). A region not listed
+ * is unknown: nothing claims a country for it, and the generated residency text never says « Canada » for it.
+ */
+declare const COUNTRY_OF_REGION: Readonly<Record<string, string>>;
+type Residency = "canada" | "elsewhere";
+/** The ISO country of a provider region, or undefined when the region is not mapped. */
+declare const countryOf: (region: string) => string | undefined;
+/** Canada only when the table says so; an unmapped region is « elsewhere », never a guess in Canada's favour. */
+declare const residencyOf: (region: string) => Residency;
+/**
+ * Residency of a configured store: the region AND the endpoint have to agree. A host that names a known region
+ * (`nyc3.digitaloceanspaces.com`, `ny.storage.bunnycdn.com`) in another country than the region setting is the contradiction that
+ * would let a text claim Canada falsely, so any known region label of the host that is not Canadian makes the answer « elsewhere ».
+ * A Bunny-shaped zone (`http`) has no Canadian region, so it is never « canada ».
+ */
+declare function residencyOfConfig(config: {
+    provider: "http" | "s3";
+    endpoint: string;
+    region: string;
+}): Residency;
+
+/** The two kinds every product shares; the others are the product's. */
+declare const STORE_KIND: {
+    readonly none: "none";
+    readonly device: "device";
+};
+/** Whose store it is: Krizaka's (the deployment's), the workspace's own, or the person's device. */
+type StoreOwner = "krizaka" | "workspace" | "device";
+/** Where objects live, as the product says it: computed from the configuration, never typed. */
+interface StoreDescriptor {
+    /** The product's name for the store (`s3`, `bunny`, `database`, `none`, `device`…). */
+    kind: string;
+    endpoint: string | null;
+    region: string | null;
+    residency: Residency | "unknown" | "device";
+    encrypted: boolean;
+    owner: StoreOwner;
+    /** For fictional and development data only: the notice says so instead of claiming a place. */
+    devOnly: boolean;
+}
+/** The descriptor of a configured store, from its configuration alone (see `residencyOfConfig`: a Bunny-shaped zone is dev only and never Canadian). */
+declare function describeStore(config: {
+    provider: "http" | "s3";
+    endpoint: string;
+    region: string;
+}, options: {
+    encrypted: boolean;
+    owner?: StoreOwner;
+    httpKind?: string;
+}): StoreDescriptor;
+interface WhereOptions {
+    /** Stores that are not configurable but fixed places (Yomizaka's managed database in Toronto), by kind. */
+    fixed?: Readonly<Record<string, StoreDescriptor>>;
+    /** Kinds that exist only for development data. */
+    devOnly?: readonly string[];
+}
+/**
+ * Where an object lives, from the store kind recorded with it and the store configured now. True at every moment, per object:
+ * a fixed place says what it is; `none` and `device` say so; the active store answers for its own kind; any other kind (a store
+ * no longer configured) says only its kind, with an unknown residency, so nothing is claimed that nothing proves.
+ */
+declare function where(kind: string, active: StoreDescriptor, options?: WhereOptions): StoreDescriptor;
+type NoticeKey = "none" | "krizakaCanadaEncrypted" | "krizakaCanada" | "krizakaElsewhere" | "workspace" | "devOnly" | "device";
+/** Which sentence says where this object lives (« Not kept », « Kept: Krizaka (Canada, encrypted) »…), with its variables; the product's messages hold the words. */
+declare function storageNotice(d: StoreDescriptor): {
+    key: NoticeKey;
+    vars: Record<string, string>;
+};
+
+export { COUNTRY_OF_REGION as C, type NoticeKey as N, type Residency as R, STORE_KIND as S, type WhereOptions as W, type StoreDescriptor as a, type StoreOwner as b, countryOf as c, describeStore as d, residencyOfConfig as e, residencyOf as r, storageNotice as s, where as w };

package/package.json

@@ -1,6 +1,89 @@
 {
   "name": "@krizaka/storage",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.3.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"
+    },
+    "./resolve": {
+      "types": "./dist/resolve.d.ts",
+      "import": "./dist/resolve.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.9.1"
+  },
+  "dependencies": {
+    "@krizaka/settings": "^0.5.0",
+    "@krizaka/db": "^0.2.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"
+  }
 }