@did-space/core 0.5.78 → 0.5.80

package/dist/es/space/space.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Stream } from 'stream';
+import EventEmitter from 'events';
+import { SpaceConfig } from '../configuration';
+import { Data, Object } from '../meta';
+import { WriteOptions, ReadOptions, SpaceProtocol, DriverProtocol, AppSpaceOptions, PermissionOptions, DeleteOptions, ListOptions, ListsOptions, GetHashOptions, KeyStatus, ReadAsOwnerOptions, ExistsAsOwnerOptions } from '../protocols';
+export declare class Space extends EventEmitter implements SpaceProtocol {
+    readonly driver: DriverProtocol;
+    static readonly READONLY_OBJECT_KEYS: string[];
+    constructor(driver: DriverProtocol);
+    createSpace(spaceConfiguration: SpaceConfig): Promise<void>;
+    destroySpace(): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    getSpaceSize(): Promise<number>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
+    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    createConfig(spaceConfig: SpaceConfig): Promise<void>;
+    destroyConfig(): Promise<void>;
+    set<T = any>(key: string, value: T): Promise<void>;
+    get<T = any>(key: string): Promise<T>;
+    setListable(options: PermissionOptions, value: boolean): Promise<void>;
+    setReadable(options: PermissionOptions, value: boolean): Promise<void>;
+    setWritable(options: PermissionOptions, value: boolean): Promise<void>;
+    isListable(options: PermissionOptions): Promise<boolean>;
+    isReadable(options: PermissionOptions): Promise<boolean>;
+    isWritable(options: PermissionOptions): Promise<boolean>;
+    getSpaceStatus(): Promise<{
+        totalCapacity: number;
+        usedCapacity: number;
+        isFull: boolean;
+    }>;
+    write(options: WriteOptions): Promise<void>;
+    delete(options: DeleteOptions): Promise<void>;
+    read(options: ReadOptions): Promise<Stream>;
+    getHash(options: GetHashOptions): Promise<string>;
+    exists(options: ReadOptions): Promise<boolean>;
+    lists(options: ListsOptions): Promise<Object[]>;
+    list(options: ListOptions): Promise<Object | null>;
+    writeAsOwner(key: string, data: Data): Promise<void>;
+    deleteAsOwner(key: string): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string, options?: ExistsAsOwnerOptions): Promise<boolean>;
+    getStatusAsOwner(key: string): Promise<KeyStatus>;
+    static editable(key: string): boolean;
+}

package/dist/es/space/space.js

@@ -0,0 +1,172 @@
+import xbytes from 'xbytes';
+import EventEmitter from 'events';
+export class Space extends EventEmitter {
+    driver;
+    static READONLY_OBJECT_KEYS = ['/config.yml'];
+    constructor(driver) {
+        super();
+        this.driver = driver;
+    }
+    createSpace(spaceConfiguration) {
+        return this.driver.createSpace(spaceConfiguration);
+    }
+    destroySpace() {
+        return this.driver.destroySpace();
+    }
+    isSpaceCreated() {
+        return this.driver.isSpaceCreated();
+    }
+    getSpaceSize() {
+        return this.driver.getSpaceSize();
+    }
+    createAppSpace(options) {
+        return this.driver.createAppSpace(options);
+    }
+    async destroyAppSpace(options) {
+        const permissionOptions = {
+            fromAppDid: options.appDid,
+            toAppDid: options.appDid,
+        };
+        await this.driver.setListable(permissionOptions, false);
+        await this.driver.setReadable(permissionOptions, false);
+        await this.driver.setWritable(permissionOptions, false);
+        return this.driver.destroyAppSpace(options);
+    }
+    getAppSpacePath(options) {
+        return this.driver.getAppSpacePath(options);
+    }
+    createConfig(spaceConfig) {
+        return this.driver.createConfig(spaceConfig);
+    }
+    destroyConfig() {
+        return this.driver.destroyConfig();
+    }
+    set(key, value) {
+        return this.driver.set(key, value);
+    }
+    get(key) {
+        return this.driver.get(key);
+    }
+    setListable(options, value) {
+        return this.driver.setListable(options, value);
+    }
+    setReadable(options, value) {
+        return this.driver.setReadable(options, value);
+    }
+    setWritable(options, value) {
+        return this.driver.setWritable(options, value);
+    }
+    isListable(options) {
+        return this.driver.isListable(options);
+    }
+    isReadable(options) {
+        return this.driver.isReadable(options);
+    }
+    isWritable(options) {
+        return this.driver.isWritable(options);
+    }
+    async getSpaceStatus() {
+        // FIXME: @yejianchao 临时性解决方案,需要新增拓容功能,需要去除白名单功能
+        const [did, totalCapacity, usedCapacity] = await Promise.all([
+            this.driver.get('did'),
+            this.driver.get('size'),
+            this.driver.getSpaceSize(),
+        ]);
+        const whiteList = (process.env?.SPACE_WHITE_LIST ?? '')
+            .split(',')
+            .map((s) => s.trim())
+            .filter(Boolean);
+        // @see: https://github.com/ArcBlock/did-spaces/issues/269#issuecomment-1430852234
+        // 存储空间无限制
+        if (totalCapacity === 0) {
+            return {
+                isFull: false,
+                totalCapacity,
+                usedCapacity,
+            };
+        }
+        // 跳过白名单
+        if (whiteList.length && whiteList.includes(did)) {
+            return {
+                isFull: false,
+                totalCapacity,
+                usedCapacity,
+            };
+        }
+        // 存储空间不足
+        if (usedCapacity >= totalCapacity) {
+            return {
+                isFull: true,
+                totalCapacity,
+                usedCapacity,
+            };
+        }
+        return {
+            isFull: false,
+            totalCapacity,
+            usedCapacity,
+        };
+    }
+    async write(options) {
+        // FIXME: @yejianchao 插入数据和编辑数据应该分离?
+        if (await this.exists(options)) {
+            return this.driver.write(options);
+        }
+        const spaceStatus = await this.getSpaceStatus();
+        if (spaceStatus.isFull) {
+            throw new Error(`Insufficient free space, total capacity is ${xbytes(spaceStatus.totalCapacity, {
+                iec: true,
+            })}, used capacity is ${xbytes(spaceStatus.usedCapacity, { iec: true })}`);
+        }
+        return this.driver.write(options);
+    }
+    delete(options) {
+        return this.driver.delete(options);
+    }
+    read(options) {
+        return this.driver.read(options);
+    }
+    getHash(options) {
+        return this.driver.getHash(options);
+    }
+    exists(options) {
+        return this.driver.exists(options);
+    }
+    lists(options) {
+        return this.driver.lists(options);
+    }
+    list(options) {
+        return this.driver.list(options);
+    }
+    async writeAsOwner(key, data) {
+        // FIXME: @yejianchao 插入数据和编辑数据应该分离
+        if (await this.existsAsOwner(key)) {
+            return this.driver.writeAsOwner(key, data);
+        }
+        const spaceStatus = await this.getSpaceStatus();
+        if (spaceStatus.isFull) {
+            throw new Error(`Insufficient free space, total capacity is ${xbytes(spaceStatus.totalCapacity, {
+                iec: true,
+            })}, used capacity is ${xbytes(spaceStatus.usedCapacity, { iec: true })}`);
+        }
+        return this.driver.writeAsOwner(key, data);
+    }
+    deleteAsOwner(key) {
+        if (Space.READONLY_OBJECT_KEYS.includes(key)) {
+            throw new Error(`Object ${key} cannot be deleted`);
+        }
+        return this.driver.deleteAsOwner(key);
+    }
+    readAsOwner(key, options) {
+        return this.driver.readAsOwner(key, options);
+    }
+    existsAsOwner(key, options) {
+        return this.driver.existsAsOwner(key, options);
+    }
+    getStatusAsOwner(key) {
+        return this.driver.getStatusAsOwner(key);
+    }
+    static editable(key) {
+        return !Space.READONLY_OBJECT_KEYS.includes(key);
+    }
+}

package/dist/es/utils/common.d.ts

@@ -0,0 +1,5 @@
+import { Data } from '../meta';
+export declare function isStream(data: any): boolean;
+export declare function getSize(data?: Data): Promise<number>;
+export declare function isDirectory(key: string): boolean;
+export declare function isValidData(data: Data): boolean;

package/dist/es/utils/common.js

@@ -0,0 +1,38 @@
+import { isBuffer, isFunction, isString } from 'lodash';
+import { Readable, Stream } from 'stream';
+export function isStream(data) {
+    return data instanceof Stream || data instanceof Readable || isFunction(data?.pipe);
+}
+// eslint-disable-next-line require-await
+export async function getSize(data = '') {
+    if (typeof data === 'string') {
+        return Buffer.byteLength(data, 'utf-8');
+    }
+    if (Buffer.isBuffer(data)) {
+        return Buffer.byteLength(data);
+    }
+    if (isStream(data)) {
+        return new Promise((resolve, reject) => {
+            let size = 0;
+            // @ts-expect-error
+            data.on('data', (chunk) => {
+                size += chunk.length;
+            });
+            // @ts-expect-error
+            data.on('end', () => {
+                resolve(size);
+            });
+            // @ts-expect-error
+            data.on('error', (err) => {
+                reject(err);
+            });
+        });
+    }
+    throw new Error(`#getSize() Invalid data type: ${data}`);
+}
+export function isDirectory(key) {
+    return key.endsWith('/');
+}
+export function isValidData(data) {
+    return isString(data) || isBuffer(data) || isStream(data);
+}

package/dist/es/utils/hash.d.ts

@@ -0,0 +1,31 @@
+import type { LiteralUnion } from 'type-fest';
+import { Data } from '../meta';
+export type Algorithm = LiteralUnion<'ipfs' | 'sha256', string>;
+/**
+ *
+ * @see cid各个版本 https://docs.ipfs.tech/concepts/content-addressing/#cid-versions
+ * @see 浏览 markle 树 https://explore.ipld.io/#/
+ * @see cidV0转cidV1 https://cid.ipfs.tech/#QmaNNTsLtScRVUfPn45s2aVbe8jLwfx6yU4Jiu45h6L9FN
+ * @description
+ * @export
+ * @param {Data} data
+ * @return {Promise<string>}  {Promise<string>}
+ */
+export declare function getHashByIpfs(data?: Data): Promise<string>;
+export declare function getHashByAlgorithm(data?: Data, algorithm?: Algorithm): Promise<string>;
+/**
+ *
+ *
+ * @export
+ * @param {Data} [data='']
+ * @param {AlgorithmName} [algorithm='ipfs']
+ */
+export declare function getHash(data?: Data, algorithm?: Algorithm): Promise<string>;
+/**
+ * @description
+ * @export
+ * @param {string} hash cid hash
+ * @return {string}  {string}
+ */
+export declare function getHashPath(hash: string): string;
+export declare function isCidV1(cid: string): boolean;

package/dist/es/utils/hash.js

@@ -0,0 +1,64 @@
+import { join } from 'path';
+import { onlyHash } from '@arcblock/ipfs-only-hash';
+import { CID } from 'multiformats';
+import hasha from 'hasha';
+import { isValidData } from './common';
+/**
+ *
+ * @see cid各个版本 https://docs.ipfs.tech/concepts/content-addressing/#cid-versions
+ * @see 浏览 markle 树 https://explore.ipld.io/#/
+ * @see cidV0转cidV1 https://cid.ipfs.tech/#QmaNNTsLtScRVUfPn45s2aVbe8jLwfx6yU4Jiu45h6L9FN
+ * @description
+ * @export
+ * @param {Data} data
+ * @return {Promise<string>}  {Promise<string>}
+ */
+export async function getHashByIpfs(data = '') {
+    const cidV0 = await onlyHash(data);
+    return CID.parse(cidV0).toV1().toString();
+}
+export function getHashByAlgorithm(data = '', algorithm = 'sha256') {
+    if (typeof data === 'string' || Buffer.isBuffer(data)) {
+        return hasha.async(data, { algorithm });
+    }
+    return hasha.fromStream(data, { algorithm });
+}
+/**
+ *
+ *
+ * @export
+ * @param {Data} [data='']
+ * @param {AlgorithmName} [algorithm='ipfs']
+ */
+// eslint-disable-next-line require-await
+export async function getHash(data = '', algorithm = 'ipfs') {
+    if (!['ipfs', 'sha256'].includes(algorithm)) {
+        throw new Error(`#getHash() Invalid algorithm type: ${algorithm}`);
+    }
+    if (!isValidData(data)) {
+        throw new Error(`#getHash() Invalid data type: ${data}`);
+    }
+    if (algorithm === 'ipfs') {
+        return getHashByIpfs(data);
+    }
+    return getHashByAlgorithm(data, algorithm);
+}
+/**
+ * @description
+ * @export
+ * @param {string} hash cid hash
+ * @return {string}  {string}
+ */
+export function getHashPath(hash) {
+    const [prefix1, prefix2] = [hash.slice(-2), hash.slice(-6, -2)];
+    return join('.objects', prefix1, prefix2, hash);
+}
+export function isCidV1(cid) {
+    try {
+        const c = CID.parse(cid);
+        return c.version === 1;
+    }
+    catch {
+        return false;
+    }
+}

package/dist/es/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './logger';
+export * from './hash';
+export * from './common';
+export * from './stream';

package/dist/es/utils/index.js

@@ -0,0 +1,4 @@
+export * from './logger';
+export * from './hash';
+export * from './common';
+export * from './stream';

package/dist/es/utils/logger.d.ts

@@ -0,0 +1,2 @@
+declare const logger: Console;
+export { logger };

package/dist/es/utils/logger.js

@@ -0,0 +1,2 @@
+const logger = console;
+export { logger };

package/dist/es/utils/stream.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+export declare function stringToStream(str: string): Readable;
+/**
+ * @see https://stackoverflow.com/a/78087909
+ * @param stream
+ * @param encoding
+ * @returns
+ */
+export declare const streamToString: (stream: any, encoding?: BufferEncoding) => Promise<string>;

package/dist/es/utils/stream.js

@@ -0,0 +1,18 @@
+import { Readable } from 'stream';
+import { buffer } from 'node:stream/consumers';
+export function stringToStream(str) {
+    const stream = new Readable();
+    stream.push(str);
+    stream.push(null);
+    return stream;
+}
+/**
+ * @see https://stackoverflow.com/a/78087909
+ * @param stream
+ * @param encoding
+ * @returns
+ */
+export const streamToString = async (stream, encoding) => {
+    const data = await buffer(stream);
+    return data.toString(encoding);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/core",
-  "version": "0.5.78",
+  "version": "0.5.80",
   "publishConfig": {
     "access": "public"
   },
@@ -12,8 +12,96 @@
   },
   "homepage": "",
   "license": "ISC",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "configuration": [
+        "./dist/cjs/configuration/index.d.ts"
+      ],
+      "constants": [
+        "./dist/cjs/constants/index.d.ts"
+      ],
+      "drivers": [
+        "./dist/cjs/drivers/index.d.ts"
+      ],
+      "meta": [
+        "./dist/cjs/meta/index.d.ts"
+      ],
+      "meta/template": [
+        "./dist/cjs/meta/template/index.d.ts"
+      ],
+      "meta/template/preview": [
+        "./dist/cjs/meta/template/preview/index.d.ts"
+      ],
+      "model": [
+        "./dist/cjs/model/index.d.ts"
+      ],
+      "protocols": [
+        "./dist/cjs/protocols/index.d.ts"
+      ],
+      "schemas": [
+        "./dist/cjs/schemas/index.d.ts"
+      ],
+      "space": [
+        "./dist/cjs/space/index.d.ts"
+      ],
+      "utils": [
+        "./dist/cjs/utils/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/es/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./configuration": {
+      "import": "./dist/es/configuration/index.js",
+      "require": "./dist/cjs/configuration/index.js"
+    },
+    "./constants": {
+      "import": "./dist/es/constants/index.js",
+      "require": "./dist/cjs/constants/index.js"
+    },
+    "./drivers": {
+      "import": "./dist/es/drivers/index.js",
+      "require": "./dist/cjs/drivers/index.js"
+    },
+    "./meta": {
+      "import": "./dist/es/meta/index.js",
+      "require": "./dist/cjs/meta/index.js"
+    },
+    "./meta/template": {
+      "import": "./dist/es/meta/template/index.js",
+      "require": "./dist/cjs/meta/template/index.js"
+    },
+    "./meta/template/preview": {
+      "import": "./dist/es/meta/template/preview/index.js",
+      "require": "./dist/cjs/meta/template/preview/index.js"
+    },
+    "./model": {
+      "import": "./dist/es/model/index.js",
+      "require": "./dist/cjs/model/index.js"
+    },
+    "./protocols": {
+      "import": "./dist/es/protocols/index.js",
+      "require": "./dist/cjs/protocols/index.js"
+    },
+    "./schemas": {
+      "import": "./dist/es/schemas/index.js",
+      "require": "./dist/cjs/schemas/index.js"
+    },
+    "./space": {
+      "import": "./dist/es/space/index.js",
+      "require": "./dist/cjs/space/index.js"
+    },
+    "./utils": {
+      "import": "./dist/es/utils/index.js",
+      "require": "./dist/cjs/utils/index.js"
+    }
+  },
   "files": [
     "dist"
   ],
@@ -23,15 +111,15 @@
     "test": "vitest run",
     "coverage": "vitest run --coverage",
     "verify": "npm run lint && npm run test && npm run build",
-    "build": "tsc",
+    "build": "node tools/auto-exports.js &&tsc --project tsconfig.json && tsc --project tsconfig.es.json",
     "watch": "npm run build -- -w"
   },
   "dependencies": {
-    "@arcblock/did": "^1.18.152",
+    "@arcblock/did": "^1.18.161",
     "@arcblock/ipfs-only-hash": "^0.0.2",
-    "@arcblock/validator": "^1.18.152",
+    "@arcblock/validator": "^1.18.161",
     "dayjs": "^1.11.13",
-    "debug": "^4.3.7",
+    "debug": "^4.4.0",
     "hasha": "^5.2.2",
     "joi": "^17.13.3",
     "js-yaml": "^4.1.0",
@@ -41,7 +129,7 @@
     "p-all": "3.0.0",
     "sequelize": "^6.37.5",
     "xbytes": "^1.9.1",
-    "zod": "^3.23.8"
+    "zod": "^3.24.1"
   },
   "devDependencies": {
     "@arcblock/eslint-config-ts": "^0.3.3",
@@ -49,6 +137,7 @@
     "@types/node": "18.19.31",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "eslint": "^8.57.1",
+    "glob": "^10.4.5",
     "jest": "^29.7.0",
     "lint-staged": "^13.3.0",
     "ts-jest": "^28.0.8",
@@ -56,5 +145,5 @@
     "vite": "^5.4.11",
     "vitest": "^2.1.8"
   },
-  "gitHead": "a78e40b323dff7d1dd378b6b2ef8fd805df4df4d"
+  "gitHead": "16c29f7cfe40d7d54a438fd4047b94519d51062e"
 }

package/dist/meta/template/app-backup.d.ts

@@ -1,55 +0,0 @@
-import { APP_BACKUP_STATUS } from '../../constants';
-export declare const APP_BACKUP_TYPE = "app-backup";
-export interface AppBackup {
-    /**
-     *
-     * @description uid
-     * @link https://www.npmjs.com/package/nanoid?activeTab=readme
-     * @type {string}
-     * @memberof AppBackup
-     */
-    id: string;
-    type: 'app-backup';
-    userDid: string;
-    /**
-     *
-     * @description 授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的
-     * @type {string}
-     * @memberof AppBackup
-     */
-    referrer: string;
-    /**
-     *
-     * @description 指向 server 的 did 地址
-     * @default ""
-     * @type {string}
-     * @memberof AppBackup
-     */
-    serverDid: string;
-    /**
-     *
-     * @description 本质上是始终指向最新的 appDid,目前主要是 rotate 的 blocklet 在还原的时候会用到这个参数
-     * @default ""
-     * @type {string}
-     * @memberof AppBackup
-     */
-    signerDid: string;
-    appName: string;
-    appDescription: string;
-    appLogoUrl?: string;
-    /**
-     * @description
-     * @type {string}
-     * @memberof AppBackup
-     */
-    status: APP_BACKUP_STATUS;
-    /**
-     * @description 目前保存着错误消息
-     * @default ""
-     * @type {string}
-     * @memberof AppBackup
-     */
-    message: string;
-    createAt: string;
-    updateAt?: string;
-}

package/dist/meta/template/app-backup.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.APP_BACKUP_TYPE = void 0;
-exports.APP_BACKUP_TYPE = 'app-backup';

package/dist/meta/template/app-connected.d.ts

@@ -1,49 +0,0 @@
-export declare const APP_CONNECT_TYPE = "app-connected";
-/**
- *
- * @description
- * @export
- * @interface AppConnected
- */
-export interface AppConnected {
-    /**
-     *
-     * @description uid
-     * @link https://www.npmjs.com/package/nanoid?activeTab=readme
-     * @type {string}
-     * @memberof AppConnected
-     */
-    id: string;
-    type: 'app-connected';
-    userDid: string;
-    spaceDid: string;
-    appDid: string;
-    appName: string;
-    appDescription: string;
-    scopes: string;
-    /**
-     *
-     * @description 注意，有了 appUrl，只要使用它的 __blocklet__.js?type=json api就能获取 blocklet的 logo，描述，等信息
-     * @type {string}
-     * @memberof AppConnected
-     */
-    appUrl: string;
-    appLogoUrl: string;
-    /**
-     *
-     * @description 授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的
-     * @type {string}
-     * @memberof AppConnected
-     */
-    referrer: string;
-    /**
-     *
-     * @description 指向 server 的 did 地址
-     * @default ""
-     * @type {string}
-     * @memberof AppBackup
-     */
-    serverDid: string;
-    createAt: string;
-    updateAt?: string;
-}

package/dist/meta/template/app-connected.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.APP_CONNECT_TYPE = void 0;
-exports.APP_CONNECT_TYPE = 'app-connected';