@mxpicture/gcp-functions-fs 0.2.0

package/dist/config/ConfigJson.d.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+export type ConfigContent = Record<string, unknown>;
+export declare class ConfigJson<T extends ConfigContent> {
+    readonly path: string;
+    readonly shape: z.ZodRawShape;
+    readonly configDir: string;
+    protected _schema: z.ZodObject | null;
+    protected _content: T | null;
+    constructor(path: string, shape: z.ZodRawShape);
+    get content(): T;
+    set content(data: T);
+    read(): Promise<void>;
+    write(): Promise<void>;
+    protected schema(): z.ZodObject<z.core.$ZodLooseShape, z.core.$strip>;
+    protected validate(content: Partial<T>): Promise<T>;
+    protected validateSync(content: Partial<T>): T;
+}

package/dist/config/ConfigJson.js

@@ -0,0 +1,47 @@
+import { dirname } from "node:path";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { z } from "zod";
+import pkg from "json5";
+import { formatJson } from "@mxpicture/gcp-functions-code/common";
+export class ConfigJson {
+    path;
+    shape;
+    configDir;
+    _schema = null;
+    _content = null;
+    constructor(path, shape) {
+        this.path = path;
+        this.shape = shape;
+        this.configDir = dirname(path);
+    }
+    get content() {
+        if (!this._content)
+            throw new Error("Content not available");
+        return this._content;
+    }
+    set content(data) {
+        this._content = this.validateSync(data);
+    }
+    async read() {
+        this._content = await this.validate(pkg.parse(await readFile(this.path, "utf8")));
+    }
+    async write() {
+        const [, content] = await Promise.all([
+            mkdir(this.configDir, { recursive: true }),
+            this.validate(this.content),
+        ]);
+        this._content = content;
+        return writeFile(this.path, await formatJson(pkg.stringify(this._content)));
+    }
+    schema() {
+        if (!this._schema)
+            this._schema = z.object(this.shape);
+        return this._schema;
+    }
+    async validate(content) {
+        return this.schema().parseAsync(content);
+    }
+    validateSync(content) {
+        return this.schema().parse(content);
+    }
+}

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export * from "./ConfigJson.js";

package/dist/config/index.js

@@ -0,0 +1,2 @@
+// This file is auto-generated. Do not edit manually.
+export * from "./ConfigJson.js";

package/dist/history/HistoryJson.d.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+export type HistoryItem = Record<string, unknown>;
+export interface HistoryRawItem<T extends HistoryItem> {
+    timestamp: string;
+    timestampRaw: number;
+    data: T;
+}
+export declare class HistoryJson<T extends HistoryItem> {
+    readonly path: string;
+    readonly itemShape: z.ZodRawShape;
+    readonly historyDir: string;
+    protected _raws: HistoryRawItem<T>[];
+    protected _itemSchema: z.ZodObject | null;
+    protected _rawItemSchema: z.ZodObject | null;
+    protected _fileSchema: z.ZodArray | null;
+    constructor(path: string, itemShape: z.ZodRawShape);
+    get items(): T[];
+    get raws(): HistoryRawItem<T>[];
+    addItem(item: T): void;
+    addItems(items: T[]): void;
+    addRaw(raw: HistoryRawItem<T>): void;
+    addRaws(raws: HistoryRawItem<T>[]): void;
+    read(): Promise<void>;
+    write(): Promise<void>;
+    protected itemSchema(): z.ZodObject<z.core.$ZodLooseShape, z.core.$strip>;
+    protected rawItemSchema(): z.ZodObject<z.core.$ZodLooseShape, z.core.$strip>;
+    protected fileSchema(): z.ZodArray<z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    protected validateItem(item: Partial<T>): Promise<T>;
+    protected validateRawItem(raw: Partial<HistoryRawItem<T>>): Promise<HistoryRawItem<T>>;
+    protected validateFile(raws: Partial<HistoryRawItem<T>>[]): Promise<HistoryRawItem<T>[]>;
+    protected sort(): void;
+    protected toItem(raw: HistoryRawItem<T>): T;
+    protected toItems(raws: HistoryRawItem<T>[]): T[];
+    protected toRaw(item: T): HistoryRawItem<T>;
+    protected toRaws(items: T[]): HistoryRawItem<T>[];
+}

package/dist/history/HistoryJson.js

@@ -0,0 +1,101 @@
+import { dirname } from "node:path";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { z } from "zod";
+import pkg from "json5";
+import { formatJson } from "@mxpicture/gcp-functions-code/common";
+export class HistoryJson {
+    path;
+    itemShape;
+    historyDir;
+    _raws = [];
+    _itemSchema = null;
+    _rawItemSchema = null;
+    _fileSchema = null;
+    constructor(path, itemShape) {
+        this.path = path;
+        this.itemShape = itemShape;
+        this.historyDir = dirname(path);
+    }
+    get items() {
+        return this._raws.map((raw) => this.toItem(raw));
+    }
+    get raws() {
+        return [...this._raws];
+    }
+    addItem(item) {
+        this.addRaw(this.toRaw(item));
+    }
+    addItems(items) {
+        this.addRaws(this.toRaws(items));
+    }
+    addRaw(raw) {
+        this._raws.unshift(raw);
+        this.sort();
+    }
+    addRaws(raws) {
+        this._raws.unshift(...raws);
+        this.sort();
+    }
+    async read() {
+        const items = pkg.parse(await readFile(this.path, "utf8"));
+        this._raws = await this.validateFile(items);
+        this.sort();
+    }
+    async write() {
+        const [, raws] = await Promise.all([
+            mkdir(this.historyDir, { recursive: true }),
+            this.validateFile(this._raws),
+        ]);
+        this._raws = raws;
+        this.sort();
+        return writeFile(this.path, await formatJson(pkg.stringify(raws)));
+    }
+    itemSchema() {
+        if (!this._itemSchema)
+            this._itemSchema = z.object(this.itemShape);
+        return this._itemSchema;
+    }
+    rawItemSchema() {
+        if (!this._rawItemSchema)
+            this._rawItemSchema = z.object({
+                timestamp: z.string(),
+                timestampRaw: z.number(),
+                data: this.itemSchema(),
+            });
+        return this._rawItemSchema;
+    }
+    fileSchema() {
+        if (!this._fileSchema)
+            this._fileSchema = z.array(this.rawItemSchema());
+        return this._fileSchema;
+    }
+    async validateItem(item) {
+        return this.itemSchema().parseAsync(item);
+    }
+    async validateRawItem(raw) {
+        return this.rawItemSchema().parseAsync(raw);
+    }
+    async validateFile(raws) {
+        return this.fileSchema().parseAsync(raws);
+    }
+    sort() {
+        this._raws.sort((a, b) => b.timestampRaw - a.timestampRaw);
+    }
+    toItem(raw) {
+        return raw.data;
+    }
+    toItems(raws) {
+        return raws.map((raw) => raw.data);
+    }
+    toRaw(item) {
+        return this.toRaws([item])[0];
+    }
+    toRaws(items) {
+        const now = new Date();
+        return items.map((item) => ({
+            timestamp: now.toISOString(),
+            timestampRaw: now.getTime(),
+            data: item,
+        }));
+    }
+}

package/dist/history/index.d.ts

@@ -0,0 +1 @@
+export * from "./HistoryJson.js";

package/dist/history/index.js

@@ -0,0 +1,2 @@
+// This file is auto-generated. Do not edit manually.
+export * from "./HistoryJson.js";

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@mxpicture/gcp-functions-fs",
+  "version": "0.2.0",
+  "description": "Tools for google cloud functions",
+  "type": "module",
+  "author": "MXPicture",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MXPicture/npm-gcp-functions.git"
+  },
+  "exports": {
+    "./history": "./dist/history/index.js",
+    "./config": "./dist/config/index.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "clean": "rm -rf dist .tsbuildinfo tsconfig.tsbuildinfo node_modules",
+    "lint": "eslint \"src/**/*.{ts,tsx}\" --ext .ts,.tsx",
+    "build": "tsc -b .",
+    "test:clean": "rm -rf src/4testing/generator-test-*",
+    "run:test": "pnpm exec tsx src/scripts/test.mts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@mxpicture/gcp-functions-code": "^0.2.0",
+    "json5": "^1.0.2",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "^25.2.0",
+    "eslint": "^9.39.2",
+    "typescript": "^5.9.3"
+  }
+}