@walkeros/server-store-fs 0.2.0-next-1773136823705 → 3.0.0

package/README.md

@@ -11,7 +11,7 @@ relative to a base directory with path traversal protection.
 
 ```json
 {
-  "version": 1,
+  "version": 3,
   "flows": {
     "default": {
       "server": {},

package/dist/dev.d.mts

@@ -1,6 +1,6 @@
 import * as _walkeros_core_dev from '@walkeros/core/dev';
 import { z } from '@walkeros/core/dev';
-import { Store } from '@walkeros/core';
+import { Flow, Store } from '@walkeros/core';
 
 declare const SettingsSchema: z.ZodObject<{
     basePath: z.ZodString;
@@ -16,12 +16,27 @@ declare namespace index$1 {
   export { type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_settings as settings };
 }
 
+/** Read a file that exists in the store directory. */
+declare const readExistingFile: Flow.StepExample;
+/** Write a file with auto-created parent directories. */
+declare const writeNewFile: Flow.StepExample;
+/** Path traversal attempt is rejected for security. */
+declare const pathTraversalRejection: Flow.StepExample;
+
+declare const step_pathTraversalRejection: typeof pathTraversalRejection;
+declare const step_readExistingFile: typeof readExistingFile;
+declare const step_writeNewFile: typeof writeNewFile;
+declare namespace step {
+  export { step_pathTraversalRejection as pathTraversalRejection, step_readExistingFile as readExistingFile, step_writeNewFile as writeNewFile };
+}
+
 /** Serve static files from a local directory */
 declare const staticAssets: Store.Config;
 
 declare const index_staticAssets: typeof staticAssets;
+declare const index_step: typeof step;
 declare namespace index {
-  export { index_staticAssets as staticAssets };
+  export { index_staticAssets as staticAssets, index_step as step };
 }
 
 export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -1,6 +1,6 @@
 import * as _walkeros_core_dev from '@walkeros/core/dev';
 import { z } from '@walkeros/core/dev';
-import { Store } from '@walkeros/core';
+import { Flow, Store } from '@walkeros/core';
 
 declare const SettingsSchema: z.ZodObject<{
     basePath: z.ZodString;
@@ -16,12 +16,27 @@ declare namespace index$1 {
   export { type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_settings as settings };
 }
 
+/** Read a file that exists in the store directory. */
+declare const readExistingFile: Flow.StepExample;
+/** Write a file with auto-created parent directories. */
+declare const writeNewFile: Flow.StepExample;
+/** Path traversal attempt is rejected for security. */
+declare const pathTraversalRejection: Flow.StepExample;
+
+declare const step_pathTraversalRejection: typeof pathTraversalRejection;
+declare const step_readExistingFile: typeof readExistingFile;
+declare const step_writeNewFile: typeof writeNewFile;
+declare namespace step {
+  export { step_pathTraversalRejection as pathTraversalRejection, step_readExistingFile as readExistingFile, step_writeNewFile as writeNewFile };
+}
+
 /** Serve static files from a local directory */
 declare const staticAssets: Store.Config;
 
 declare const index_staticAssets: typeof staticAssets;
+declare const index_step: typeof step;
 declare namespace index {
-  export { index_staticAssets as staticAssets };
+  export { index_staticAssets as staticAssets, index_step as step };
 }
 
 export { index as examples, index$1 as schemas };

package/dist/dev.js

@@ -1 +1 @@
-"use strict";var e,t=Object.defineProperty,r=Object.getOwnPropertyDescriptor,o=Object.getOwnPropertyNames,s=Object.prototype.hasOwnProperty,a=(e,r)=>{for(var o in r)t(e,o,{get:r[o],enumerable:!0})},i={};a(i,{examples:()=>u,schemas:()=>c}),module.exports=(e=i,((e,a,i,c)=>{if(a&&"object"==typeof a||"function"==typeof a)for(let l of o(a))s.call(e,l)||l===i||t(e,l,{get:()=>a[l],enumerable:!(c=r(a,l))||c.enumerable});return e})(t({},"__esModule",{value:!0}),e));var c={};a(c,{SettingsSchema:()=>p,settings:()=>b});var l=require("@walkeros/core/dev"),n=require("@walkeros/core/dev"),p=n.z.object({basePath:n.z.string().min(1).describe("Root directory for file operations. All keys are resolved relative to this path.")}),b=(0,l.zodToSchema)(p),u={};a(u,{staticAssets:()=>f});var f={settings:{basePath:"./public"}};//# sourceMappingURL=dev.js.map
+"use strict";var e,t=Object.defineProperty,r=Object.getOwnPropertyDescriptor,a=Object.getOwnPropertyNames,i=Object.prototype.hasOwnProperty,s=(e,r)=>{for(var a in r)t(e,a,{get:r[a],enumerable:!0})},o={};s(o,{examples:()=>d,schemas:()=>n}),module.exports=(e=o,((e,s,o,n)=>{if(s&&"object"==typeof s||"function"==typeof s)for(let c of a(s))i.call(e,c)||c===o||t(e,c,{get:()=>s[c],enumerable:!(n=r(s,c))||n.enumerable});return e})(t({},"__esModule",{value:!0}),e));var n={};s(n,{SettingsSchema:()=>u,settings:()=>p});var c=require("@walkeros/core/dev"),l=require("@walkeros/core/dev"),u=l.z.object({basePath:l.z.string().min(1).describe("Root directory for file operations. All keys are resolved relative to this path.")}),p=(0,c.zodToSchema)(u),d={};s(d,{staticAssets:()=>b,step:()=>v});var v={};s(v,{pathTraversalRejection:()=>m,readExistingFile:()=>f,writeNewFile:()=>g});var f={description:"Read an existing file and receive its contents as a Buffer",in:{operation:"get",key:"walker.js"},out:{value:'Buffer<console.log("walkerOS")>'}},g={description:"Write creates intermediate directories automatically",in:{operation:"set",key:"js/custom/tracker.js",value:"Buffer<(function(){...})()>"},out:{written:!0,path:"{basePath}/js/custom/tracker.js"}},m={description:"Path traversal via .. segments is rejected with a warning",in:{operation:"get",key:"../../etc/passwd"},out:{value:void 0,rejected:!0}},b={settings:{basePath:"./public"}};//# sourceMappingURL=dev.js.map

package/dist/dev.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/examples/index.ts"],"sourcesContent":["export * as schemas from './schemas';\nexport * as examples from './examples';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\nexport { SettingsSchema, type Settings } from './settings';\n\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  basePath: z\n    .string()\n    .min(1)\n    .describe(\n      'Root directory for file operations. All keys are resolved relative to this path.',\n    ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import type { Store } from '@walkeros/core';\n\n/** Serve static files from a local directory */\nexport const staticAssets: Store.Config = {\n  settings: {\n    basePath: './public',\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,iBAAkB;AAEX,IAAM,iBAAiB,aAAE,OAAO;AAAA,EACrC,UAAU,aACP,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;ADJM,IAAM,eAAW,yBAAY,cAAc;;;AELlD;AAAA;AAAA;AAAA;AAGO,IAAM,eAA6B;AAAA,EACxC,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AACF;","names":["import_dev"]}
+{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/examples/index.ts","../src/examples/step.ts"],"sourcesContent":["export * as schemas from './schemas';\nexport * as examples from './examples';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\nexport { SettingsSchema, type Settings } from './settings';\n\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  basePath: z\n    .string()\n    .min(1)\n    .describe(\n      'Root directory for file operations. All keys are resolved relative to this path.',\n    ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import type { Store } from '@walkeros/core';\n\n/** Serve static files from a local directory */\nexport const staticAssets: Store.Config = {\n  settings: {\n    basePath: './public',\n  },\n};\n\nexport * as step from './step';\n","import type { Flow } from '@walkeros/core';\n\n/** Read a file that exists in the store directory. */\nexport const readExistingFile: Flow.StepExample = {\n  description: 'Read an existing file and receive its contents as a Buffer',\n  in: { operation: 'get', key: 'walker.js' },\n  out: { value: 'Buffer<console.log(\"walkerOS\")>' },\n};\n\n/** Write a file with auto-created parent directories. */\nexport const writeNewFile: Flow.StepExample = {\n  description: 'Write creates intermediate directories automatically',\n  in: {\n    operation: 'set',\n    key: 'js/custom/tracker.js',\n    value: 'Buffer<(function(){...})()>',\n  },\n  out: { written: true, path: '{basePath}/js/custom/tracker.js' },\n};\n\n/** Path traversal attempt is rejected for security. */\nexport const pathTraversalRejection: Flow.StepExample = {\n  description: 'Path traversal via .. segments is rejected with a warning',\n  in: { operation: 'get', key: '../../etc/passwd' },\n  out: { value: undefined, rejected: true },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,iBAAkB;AAEX,IAAM,iBAAiB,aAAE,OAAO;AAAA,EACrC,UAAU,aACP,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;ADJM,IAAM,eAAW,yBAAY,cAAc;;;AELlD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,IAAM,mBAAqC;AAAA,EAChD,aAAa;AAAA,EACb,IAAI,EAAE,WAAW,OAAO,KAAK,YAAY;AAAA,EACzC,KAAK,EAAE,OAAO,kCAAkC;AAClD;AAGO,IAAM,eAAiC;AAAA,EAC5C,aAAa;AAAA,EACb,IAAI;AAAA,IACF,WAAW;AAAA,IACX,KAAK;AAAA,IACL,OAAO;AAAA,EACT;AAAA,EACA,KAAK,EAAE,SAAS,MAAM,MAAM,kCAAkC;AAChE;AAGO,IAAM,yBAA2C;AAAA,EACtD,aAAa;AAAA,EACb,IAAI,EAAE,WAAW,OAAO,KAAK,mBAAmB;AAAA,EAChD,KAAK,EAAE,OAAO,QAAW,UAAU,KAAK;AAC1C;;;ADtBO,IAAM,eAA6B;AAAA,EACxC,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AACF;","names":["import_dev"]}

package/dist/dev.mjs

@@ -1 +1 @@
-var e=Object.defineProperty,r=(r,t)=>{for(var s in t)e(r,s,{get:t[s],enumerable:!0})},t={};r(t,{SettingsSchema:()=>o,settings:()=>i});import{zodToSchema as s}from"@walkeros/core/dev";import{z as a}from"@walkeros/core/dev";var o=a.object({basePath:a.string().min(1).describe("Root directory for file operations. All keys are resolved relative to this path.")}),i=s(o),c={};r(c,{staticAssets:()=>l});var l={settings:{basePath:"./public"}};export{c as examples,t as schemas};//# sourceMappingURL=dev.mjs.map
+var e=Object.defineProperty,t=(t,r)=>{for(var a in r)e(t,a,{get:r[a],enumerable:!0})},r={};t(r,{SettingsSchema:()=>s,settings:()=>o});import{zodToSchema as a}from"@walkeros/core/dev";import{z as i}from"@walkeros/core/dev";var s=i.object({basePath:i.string().min(1).describe("Root directory for file operations. All keys are resolved relative to this path.")}),o=a(s),n={};t(n,{staticAssets:()=>v,step:()=>c});var c={};t(c,{pathTraversalRejection:()=>p,readExistingFile:()=>l,writeNewFile:()=>d});var l={description:"Read an existing file and receive its contents as a Buffer",in:{operation:"get",key:"walker.js"},out:{value:'Buffer<console.log("walkerOS")>'}},d={description:"Write creates intermediate directories automatically",in:{operation:"set",key:"js/custom/tracker.js",value:"Buffer<(function(){...})()>"},out:{written:!0,path:"{basePath}/js/custom/tracker.js"}},p={description:"Path traversal via .. segments is rejected with a warning",in:{operation:"get",key:"../../etc/passwd"},out:{value:void 0,rejected:!0}},v={settings:{basePath:"./public"}};export{n as examples,r as schemas};//# sourceMappingURL=dev.mjs.map

package/dist/dev.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/examples/index.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\nexport { SettingsSchema, type Settings } from './settings';\n\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  basePath: z\n    .string()\n    .min(1)\n    .describe(\n      'Root directory for file operations. All keys are resolved relative to this path.',\n    ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import type { Store } from '@walkeros/core';\n\n/** Serve static files from a local directory */\nexport const staticAssets: Store.Config = {\n  settings: {\n    basePath: './public',\n  },\n};\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,SAAS;AAEX,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,UAAU,EACP,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;ADJM,IAAM,WAAW,YAAY,cAAc;;;AELlD;AAAA;AAAA;AAAA;AAGO,IAAM,eAA6B;AAAA,EACxC,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AACF;","names":[]}
+{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/examples/index.ts","../src/examples/step.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\nexport { SettingsSchema, type Settings } from './settings';\n\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  basePath: z\n    .string()\n    .min(1)\n    .describe(\n      'Root directory for file operations. All keys are resolved relative to this path.',\n    ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import type { Store } from '@walkeros/core';\n\n/** Serve static files from a local directory */\nexport const staticAssets: Store.Config = {\n  settings: {\n    basePath: './public',\n  },\n};\n\nexport * as step from './step';\n","import type { Flow } from '@walkeros/core';\n\n/** Read a file that exists in the store directory. */\nexport const readExistingFile: Flow.StepExample = {\n  description: 'Read an existing file and receive its contents as a Buffer',\n  in: { operation: 'get', key: 'walker.js' },\n  out: { value: 'Buffer<console.log(\"walkerOS\")>' },\n};\n\n/** Write a file with auto-created parent directories. */\nexport const writeNewFile: Flow.StepExample = {\n  description: 'Write creates intermediate directories automatically',\n  in: {\n    operation: 'set',\n    key: 'js/custom/tracker.js',\n    value: 'Buffer<(function(){...})()>',\n  },\n  out: { written: true, path: '{basePath}/js/custom/tracker.js' },\n};\n\n/** Path traversal attempt is rejected for security. */\nexport const pathTraversalRejection: Flow.StepExample = {\n  description: 'Path traversal via .. segments is rejected with a warning',\n  in: { operation: 'get', key: '../../etc/passwd' },\n  out: { value: undefined, rejected: true },\n};\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,SAAS;AAEX,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,UAAU,EACP,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;ADJM,IAAM,WAAW,YAAY,cAAc;;;AELlD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,IAAM,mBAAqC;AAAA,EAChD,aAAa;AAAA,EACb,IAAI,EAAE,WAAW,OAAO,KAAK,YAAY;AAAA,EACzC,KAAK,EAAE,OAAO,kCAAkC;AAClD;AAGO,IAAM,eAAiC;AAAA,EAC5C,aAAa;AAAA,EACb,IAAI;AAAA,IACF,WAAW;AAAA,IACX,KAAK;AAAA,IACL,OAAO;AAAA,EACT;AAAA,EACA,KAAK,EAAE,SAAS,MAAM,MAAM,kCAAkC;AAChE;AAGO,IAAM,yBAA2C;AAAA,EACtD,aAAa;AAAA,EACb,IAAI,EAAE,WAAW,OAAO,KAAK,mBAAmB;AAAA,EAChD,KAAK,EAAE,OAAO,QAAW,UAAU,KAAK;AAC1C;;;ADtBO,IAAM,eAA6B;AAAA,EACxC,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AACF;","names":[]}

package/dist/walkerOS.json

@@ -3,7 +3,9 @@
     "package": "@walkeros/server-store-fs",
     "version": "0.1.0",
     "type": "store",
-    "platform": "server"
+    "platform": "server",
+    "docs": "https://www.walkeros.io/docs/stores/server/fs",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/stores/fs/src"
   },
   "schemas": {
     "settings": {
@@ -27,6 +29,40 @@
       "settings": {
         "basePath": "./public"
       }
+    },
+    "step": {
+      "pathTraversalRejection": {
+        "description": "Path traversal via .. segments is rejected with a warning",
+        "in": {
+          "operation": "get",
+          "key": "../../etc/passwd"
+        },
+        "out": {
+          "rejected": true
+        }
+      },
+      "readExistingFile": {
+        "description": "Read an existing file and receive its contents as a Buffer",
+        "in": {
+          "operation": "get",
+          "key": "walker.js"
+        },
+        "out": {
+          "value": "Buffer<console.log(\"walkerOS\")>"
+        }
+      },
+      "writeNewFile": {
+        "description": "Write creates intermediate directories automatically",
+        "in": {
+          "operation": "set",
+          "key": "js/custom/tracker.js",
+          "value": "Buffer<(function(){...})()>"
+        },
+        "out": {
+          "written": true,
+          "path": "{basePath}/js/custom/tracker.js"
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@walkeros/server-store-fs",
   "description": "Filesystem store for walkerOS server - reads and writes files via the Store interface",
-  "version": "0.2.0-next-1773136823705",
+  "version": "3.0.0",
   "license": "MIT",
-  "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -32,10 +31,10 @@
     "update": "npx npm-check-updates -u && npm update"
   },
   "dependencies": {
-    "@walkeros/core": "2.2.0-next-1773136823705"
+    "@walkeros/core": "^3.0.0"
   },
   "devDependencies": {
-    "@walkeros/core": "2.2.0-next-1773136823705"
+    "@walkeros/core": "^3.0.0"
   },
   "repository": {
     "url": "git+https://github.com/elbwalker/walkerOS.git",
@@ -48,7 +47,8 @@
   },
   "walkerOS": {
     "type": "store",
-    "platform": "server"
+    "platform": "server",
+    "docs": "https://www.walkeros.io/docs/stores/server/fs"
   },
   "keywords": [
     "walkerOS",