@coreframe/object-storage 0.0.0 → 0.1.0

package/dist/credentials.d.ts

@@ -0,0 +1,35 @@
+//#region src/credentials.d.ts
+declare const assetCredentialEnvironment: {
+  readonly applicationKey: "COREFRAME_ASSETS_B2_APPLICATION_KEY";
+  readonly applicationKeyId: "COREFRAME_ASSETS_B2_APPLICATION_KEY_ID";
+};
+type AssetCredentials = {
+  applicationKey: string;
+  applicationKeyId: string;
+};
+type AssetCredentialStore = {
+  get(profile: string): Promise<AssetCredentials | undefined>;
+  set(profile: string, credentials: AssetCredentials): Promise<void>;
+};
+declare function systemAssetCredentialStore(): AssetCredentialStore;
+declare function resolveAssetCredentials({
+  env,
+  profile,
+  store
+}: {
+  env?: NodeJS.ProcessEnv;
+  profile: string;
+  store?: AssetCredentialStore;
+}): Promise<AssetCredentials>;
+declare function configureAssetCredentials({
+  applicationKey,
+  applicationKeyId,
+  profile,
+  store
+}: AssetCredentials & {
+  profile: string;
+  store?: AssetCredentialStore;
+}): Promise<void>;
+declare function assertAssetCredentialProfile(profile: string): string;
+//#endregion
+export { AssetCredentialStore, AssetCredentials, assertAssetCredentialProfile, assetCredentialEnvironment, configureAssetCredentials, resolveAssetCredentials, systemAssetCredentialStore };

package/dist/credentials.js

@@ -0,0 +1 @@
+import{process as e}from"./environment.js";import{getKeyring as t,getPassword as n,initBackend as r,setPassword as i}from"cross-keychain";const a=`dev.coreframe.assets`,o=new Set([`macos`,`native-macos`,`native-windows`,`secret-service`,`windows`]),s={applicationKey:`COREFRAME_ASSETS_B2_APPLICATION_KEY`,applicationKeyId:`COREFRAME_ASSETS_B2_APPLICATION_KEY_ID`};function c(){let e=!1;async function s(){if(e)return;await r(e=>o.has(e.id));let n=await t();if(!o.has(n.id))throw Error(`No supported operating system credential store is available. Coreframe requires macOS Keychain, Windows Credential Manager, or Linux Secret Service.`);e=!0}return{async get(e){await s();let t=await n(a,e);if(t)try{return p(JSON.parse(t))}catch{throw Error(`The Coreframe asset credential profile "${e}" is invalid. Run: coreframe assets configure ${e}`)}},async set(e,t){await s(),await i(a,e,JSON.stringify(p(t)))}}}async function l({env:t=e.env,profile:n,store:r=c()}){let i=t[s.applicationKeyId],a=t[s.applicationKey];if(i||a){if(!i||!a)throw Error(`${s.applicationKeyId} and ${s.applicationKey} must be provided together.`);return{applicationKey:a,applicationKeyId:i}}let o;try{o=await r.get(n)}catch(e){throw Error(`Coreframe could not access the operating system credential store for asset profile "${n}": ${e.message}`)}if(!o)throw Error(`Coreframe asset credential profile "${n}" is not configured. Run: coreframe assets configure ${n}`);return o}async function u({applicationKey:e,applicationKeyId:t,profile:n,store:r=c()}){f(n);try{await r.set(n,p({applicationKey:e,applicationKeyId:t}))}catch(e){throw Error(`Coreframe could not store asset profile "${n}" in the operating system credential store: ${e.message}`)}}function d(e){return f(e),e}function f(e){if(!/^[a-z0-9][a-z0-9._-]*$/.test(e))throw Error(`Credential profiles must start with a lowercase letter or number and contain only lowercase letters, numbers, dots, underscores, or hyphens.`)}function p(e){if(!e||typeof e!=`object`||typeof e.applicationKeyId!=`string`||!e.applicationKeyId.trim()||typeof e.applicationKey!=`string`||!e.applicationKey.trim())throw Error(`Asset credentials require a non-empty application key ID and application key.`);return{applicationKeyId:e.applicationKeyId.trim(),applicationKey:e.applicationKey}}export{d as assertAssetCredentialProfile,s as assetCredentialEnvironment,u as configureAssetCredentials,l as resolveAssetCredentials,c as systemAssetCredentialStore};

package/dist/environment.js

@@ -0,0 +1 @@
+import{createReadStream as e,createWriteStream as t}from"node:fs";import{stat as n}from"node:fs/promises";import r from"node:process";const i={createReadStream:e,createWriteStream:t,stat:n},a={env:r.env,pid:r.pid};export{i as fs,a as process};

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { AssetCredentialStore, AssetCredentials, assertAssetCredentialProfile, assetCredentialEnvironment, configureAssetCredentials, resolveAssetCredentials, systemAssetCredentialStore } from "./credentials.js";
+
+//#region src/index.d.ts
+type PrivateObjectStore = {
+  has(bucket: string, key: string): Promise<boolean>;
+  download(bucket: string, key: string, target: string): Promise<void>;
+  upload(bucket: string, key: string, source: string, contentType: string): Promise<void>;
+};
+type PrivateObjectStoreConfig = {
+  credentialProfile: string;
+  endpoint: string;
+  region: string;
+};
+/**
+ * Creates the shared private S3-compatible store used by managed-asset sources and build-only state
+ * such as i18n snapshots. The credential names remain compatible with existing Coreframe projects.
+ */
+declare function createB2PrivateObjectStore({
+  config,
+  credentialStore,
+  env
+}: {
+  config: PrivateObjectStoreConfig;
+  credentialStore?: AssetCredentialStore;
+  env?: NodeJS.ProcessEnv;
+}): PrivateObjectStore;
+//#endregion
+export { type AssetCredentialStore, type AssetCredentials, PrivateObjectStore, PrivateObjectStoreConfig, assertAssetCredentialProfile, assetCredentialEnvironment, configureAssetCredentials, createB2PrivateObjectStore, resolveAssetCredentials, systemAssetCredentialStore };

package/dist/index.js

@@ -0,0 +1 @@
+import{fs as e,process as t}from"./environment.js";import{assertAssetCredentialProfile as n,assetCredentialEnvironment as r,configureAssetCredentials as i,resolveAssetCredentials as a,systemAssetCredentialStore as o}from"./credentials.js";import{pipeline as s}from"node:stream/promises";import{GetObjectCommand as c,HeadObjectCommand as l,PutObjectCommand as u,S3Client as d}from"@aws-sdk/client-s3";function f({config:n,credentialStore:r,env:i=t.env}){let o;async function f(){if(o)return o;let e=await a({env:i,profile:n.credentialProfile,store:r});return o=new d({endpoint:n.endpoint,forcePathStyle:!0,region:n.region,credentials:{accessKeyId:e.applicationKeyId,secretAccessKey:e.applicationKey}}),o}return{async has(e,t){try{return await(await f()).send(new l({Bucket:e,Key:t})),!0}catch(e){if(e.$metadata?.httpStatusCode===404)return!1;throw e}},async download(t,n,r){let i=await(await f()).send(new c({Bucket:t,Key:n}));if(!i.Body)throw Error(`Backblaze B2 returned an empty body for ${t}/${n}.`);await s(i.Body,e.createWriteStream(r,{flags:`wx`}))},async upload(t,n,r,i){let{size:a}=await e.stat(r);await(await f()).send(new u({Bucket:t,Key:n,Body:e.createReadStream(r),ContentLength:a,ContentType:i}))}}}export{n as assertAssetCredentialProfile,r as assetCredentialEnvironment,i as configureAssetCredentials,f as createB2PrivateObjectStore,a as resolveAssetCredentials,o as systemAssetCredentialStore};

package/package.json

@@ -1,13 +1,36 @@
 {
   "name": "@coreframe/object-storage",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/airlock-labs/coreframe.git",
+    "directory": "node/object-storage"
+  },
+  "files": [
+    "dist/"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1090.0",
+    "cross-keychain": "1.1.0"
   },
-  "keywords": [],
-  "author": "",
-  "license": "All rights reserved",
-  "type": "commonjs"
-}
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "tsdown": "0.22.3",
+    "typescript": "6.0.3",
+    "vitest": "^4.1.9"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run --reporter=minimal",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "format": "oxlint --fix && oxfmt",
+    "lint": "oxlint"
+  }
+}

package/readme.md

@@ -1 +0,0 @@
-Coming soon...