@occultist/occultist 0.0.1 → 0.0.3

package/dist/cache/file.d.ts

@@ -0,0 +1,14 @@
+import type { CacheDetails, CacheHitHandle, CacheMeta, CacheStorage, CacheMissHandle } from './types.js';
+export declare class FileCacheMeta implements CacheMeta {
+    #private;
+    constructor(filePath: string);
+    get(key: string): Promise<CacheHitHandle | CacheMissHandle>;
+    set(key: string, details: CacheDetails): Promise<void>;
+}
+export declare class FileSystemCacheStorage implements CacheStorage {
+    #private;
+    hash(key: string): string;
+    get(key: string): Promise<Blob>;
+    set(key: string, value: Blob): Promise<void>;
+    invalidate(key: string): Promise<void>;
+}

package/dist/cache/file.js

@@ -0,0 +1,62 @@
+import { createHash } from 'node:crypto';
+import { open, readFile, writeFile, rm } from 'node:fs/promises';
+import { join } from 'node:path';
+export class FileCacheMeta {
+    #filePath;
+    #handle;
+    #details = {};
+    constructor(filePath) {
+        this.#filePath = filePath;
+    }
+    async #init() {
+        this.#handle = await open(this.#filePath, 'w+');
+        const content = await this.#handle.readFile({ encoding: 'utf-8' });
+        this.#details = JSON.parse(content);
+    }
+    async get(key) {
+        if (this.#handle == null) {
+            this.#init();
+        }
+        const details = this.#details[key];
+        async function set(details) {
+            this.#details.set(key, details);
+        }
+        if (details == null) {
+            return {
+                type: 'cache-miss',
+                set,
+            };
+        }
+        return {
+            ...details,
+            type: 'cache-hit',
+            set,
+        };
+    }
+    async set(key, details) {
+        this.#details[key] = details;
+        this.#handle.writeFile(JSON.stringify(details));
+    }
+}
+export class FileSystemCacheStorage {
+    #directory;
+    #hashes = new Map();
+    hash(key) {
+        let hash = this.#hashes.get(key);
+        if (hash != null)
+            return hash;
+        hash = createHash('md5').update(key).digest('hex');
+        this.#hashes.set(key, hash);
+        return hash;
+    }
+    async get(key) {
+        const buffer = await readFile(join(this.#directory, this.hash(key)));
+        return new Blob([buffer]);
+    }
+    async set(key, value) {
+        await writeFile(join(this.#directory, this.hash(key)), value.stream());
+    }
+    async invalidate(key) {
+        await rm(join(this.#directory, this.hash(key)));
+    }
+}

package/dist/processAction.js

@@ -6,16 +6,15 @@ import { isNil } from "./utils/isNil.js";
 import { isObject } from "./utils/isObject.js";
 import { isPopulatedObject } from "./utils/isPopulatedObject.js";
 import { makeAppendProblemDetails } from "./utils/makeAppendProblemDetails.js";
-import { failsRequiredRequirement, failsTypeRequirement, failsContentTypeRequirement, failsMaxValue, failsMinValue, failValueMinLength, failValueMaxLength, failsStepValue, failsPatternValue, failsValidator, isObjectArraySpec, isObjectSpec, isArraySpec } from "./validators.js";
+import { failsRequiredRequirement, failsTypeRequirement, failsContentTypeRequirement, failsMaxValue, failsMinValue, failsValueMinLength, failsValueMaxLength, failsStepValue, failsPatternValue, failsValidator, isObjectArraySpec, isObjectSpec, isArraySpec } from "./validators.js";
 import { InvalidActionParamsError, ProblemDetailsError } from "./errors.js";
 import { alwaysArray } from "./utils/alwaysArray.js";
 export async function processAction({ iri, req, spec, state, action, }) {
     let httpStatus = null;
-    const payload = {};
-    const transformers = {};
-    const refs = {};
+    const payload = Object.create(null);
+    const transformers = Object.create(null);
+    const refs = Object.create(null);
     const appendProblemDetailsParam = makeAppendProblemDetails(refs);
-    console.log('SPEC', spec);
     let params;
     let query;
     let iriValues;
@@ -117,7 +116,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             });
             return null;
         }
-        else if (failValueMinLength(value, specValue)) {
+        else if (failsValueMinLength(value, specValue)) {
             appendProblemDetailsParam({
                 status: 400,
                 param: {
@@ -128,7 +127,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             });
             return null;
         }
-        else if (failValueMaxLength(value, specValue)) {
+        else if (failsValueMaxLength(value, specValue)) {
             appendProblemDetailsParam({
                 status: 400,
                 param: {
@@ -221,7 +220,6 @@ export async function processAction({ iri, req, spec, state, action, }) {
             return [];
         }
         if (failsTypeRequirement(parentValue, specValue)) {
-            throw new Error('Nope');
             appendProblemDetailsParam({
                 param: {
                     name: paramName,
@@ -233,7 +231,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             return null;
         }
         const arrayValue = alwaysArray(parentValue);
-        if (failValueMinLength(arrayValue, specValue)) {
+        if (failsValueMinLength(arrayValue, specValue)) {
             appendProblemDetailsParam({
                 param: {
                     name: paramName,
@@ -244,7 +242,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             });
             return null;
         }
-        else if (failValueMaxLength(arrayValue, specValue)) {
+        else if (failsValueMaxLength(arrayValue, specValue)) {
             appendProblemDetailsParam({
                 param: {
                     name: paramName,
@@ -337,7 +335,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             return null;
         }
         const arrayValue = alwaysArray(parentValue);
-        if (failValueMinLength(arrayValue, specValue)) {
+        if (failsValueMinLength(arrayValue, specValue)) {
             appendProblemDetailsParam({
                 param: {
                     name: paramName,
@@ -348,7 +346,7 @@ export async function processAction({ iri, req, spec, state, action, }) {
             });
             return null;
         }
-        else if (failValueMaxLength(arrayValue, specValue)) {
+        else if (failsValueMaxLength(arrayValue, specValue)) {
             appendProblemDetailsParam({
                 param: {
                     name: paramName,

package/dist/utils/getRequestBodyValues.js

@@ -1,7 +1,7 @@
 import { ProblemDetailsError } from "../errors.js";
 import jsonld from 'jsonld';
 export async function getRequestBodyValues({ req, action, }) {
-    let bodyValues = {};
+    let bodyValues = Object.create(null);
     const contentType = req.headers.get('content-type');
     const mappedTypes = Object.entries(action.spec)
         .reduce((acc, [term, propertySpec]) => {
@@ -118,5 +118,6 @@ export async function getRequestBodyValues({ req, action, }) {
         delete compacted['@context'];
         bodyValues = compacted;
     }
+    Object.freeze(bodyValues);
     return { bodyValues };
 }

package/dist/utils/getRequestIRIValues.js

@@ -1,12 +1,12 @@
 import { ProblemDetailsError } from "../errors.js";
 import { getParamLocation } from "./getParamLocation.js";
 export function getRequestIRIValues({ iri, action, }) {
-    const pathValues = {};
-    const queryValues = {};
+    const pathValues = Object.create(null);
+    const queryValues = Object.create(null);
     // deno-lint-ignore no-explicit-any
-    const iriValues = {};
+    const iriValues = Object.create(null);
     const urlPatternResult = action.pattern.exec(iri);
-    const pathParams = urlPatternResult?.pathname.groups || {};
+    const pathParams = urlPatternResult?.pathname.groups || Object.create(null);
     const searchParams = new URL(iri).searchParams;
     const valueNames = Object.values(action.spec)
         .filter((specItem) => typeof specItem.valueName === 'string')

package/dist/validators.d.ts

@@ -11,6 +11,6 @@ export declare function failsMinValue(value: JSONValue, specValue: PropertySpec)
 export declare function failsMaxValue(value: JSONValue, specValue: PropertySpec): boolean;
 export declare function failsStepValue(value: JSONValue, specValue: PropertySpec): boolean;
 export declare function failsPatternValue(value: JSONValue, specValue: PropertySpec): boolean;
-export declare function failValueMinLength(value: JSONValue, specValue: PropertySpec): boolean;
-export declare function failValueMaxLength(value: JSONValue, specValue: PropertySpec): boolean;
+export declare function failsValueMinLength(value: JSONValue, specValue: PropertySpec): boolean;
+export declare function failsValueMaxLength(value: JSONValue, specValue: PropertySpec): boolean;
 export declare function failsValidator(value: JSONValue | File, specValue: PropertySpec): boolean;

package/dist/validators.js

@@ -20,7 +20,7 @@ export function isArraySpec(spec) {
     return !isObject(spec.properties) && Boolean(spec.multipleValues);
 }
 export function failsRequiredRequirement(value, specValue) {
-    return specValue.valueRequired && (typeof value === 'undefined' || value === null);
+    return specValue.valueRequired && value == null;
 }
 export function failsTypeRequirement(value, specValue) {
     const dataType = specValue.dataType;
@@ -107,7 +107,7 @@ export function failsPatternValue(value, specValue) {
     const regexp = new RegExp(specValue.valuePattern);
     return !regexp.test(value);
 }
-export function failValueMinLength(value, specValue) {
+export function failsValueMinLength(value, specValue) {
     if (typeof specValue.valueMinLength !== 'number') {
         return false;
     }
@@ -116,7 +116,7 @@ export function failValueMinLength(value, specValue) {
     }
     return true;
 }
-export function failValueMaxLength(value, specValue) {
+export function failsValueMaxLength(value, specValue) {
     if (typeof specValue.valueMaxLength !== 'number') {
         return false;
     }

package/lib/cache/file.ts

@@ -0,0 +1,86 @@
+import {createHash} from 'node:crypto';
+import type {CacheDetails, CacheHitHandle, CacheMeta, CacheStorage, CacheMissHandle} from './types.js';
+import {FileHandle, open, readFile, writeFile, rm} from 'node:fs/promises';
+import {join} from 'node:path';
+
+
+
+export class FileCacheMeta implements CacheMeta {
+  
+  #filePath: string;
+  #handle: FileHandle | undefined;
+  #details: Record<string, CacheDetails> = {};
+
+  constructor(filePath: string) {
+    this.#filePath = filePath;
+  }
+
+  async #init(): Promise<void> {
+    this.#handle = await open(this.#filePath, 'w+');
+    const content = await this.#handle.readFile({ encoding: 'utf-8' });
+
+    this.#details = JSON.parse(content);
+  }
+
+  async get(key: string): Promise<CacheHitHandle| CacheMissHandle> {
+    if (this.#handle == null) {
+      this.#init();
+    }
+    
+    const details = this.#details[key];
+    async function set(details: CacheDetails) {
+      this.#details.set(key, details);
+    }
+
+    if (details == null) {
+      return {
+        type: 'cache-miss',
+        set,
+      };
+    }
+    
+    return {
+      ...details,
+      type: 'cache-hit',
+      set,
+    };
+  }
+
+  async set(key: string, details: CacheDetails) {
+    this.#details[key] = details;
+    this.#handle.writeFile(JSON.stringify(details));
+  }
+
+}
+
+export class FileSystemCacheStorage implements CacheStorage {
+
+  #directory: string;
+  #hashes: Map<string, string> = new Map();
+  
+  hash(key: string): string {
+    let hash = this.#hashes.get(key);
+    
+    if (hash != null) return hash;
+
+    hash = createHash('md5').update(key).digest('hex');
+
+    this.#hashes.set(key, hash);
+
+    return hash;
+  }
+  
+  async get(key: string): Promise<Blob> {
+    const buffer = await readFile(join(this.#directory, this.hash(key)));
+
+    return new Blob([buffer]);
+  }
+
+  async set(key: string, value: Blob): Promise<void> {
+    await writeFile(join(this.#directory, this.hash(key)), value.stream());
+  }
+
+  async invalidate(key: string): Promise<void> {
+    await rm(join(this.#directory, this.hash(key)));
+  }
+}

package/lib/processAction.ts

@@ -7,7 +7,7 @@ import { isNil } from "./utils/isNil.js";
 import { isObject } from "./utils/isObject.js";
 import { isPopulatedObject } from "./utils/isPopulatedObject.js";
 import { type ProblemDetailsParamsRefs, makeAppendProblemDetails } from "./utils/makeAppendProblemDetails.js";
-import { failsRequiredRequirement, failsTypeRequirement, failsContentTypeRequirement, failsMaxValue, failsMinValue, failValueMinLength, failValueMaxLength, failsStepValue, failsPatternValue, failsValidator, isObjectArraySpec, isObjectSpec, isArraySpec } from "./validators.js";
+import { failsRequiredRequirement, failsTypeRequirement, failsContentTypeRequirement, failsMaxValue, failsMinValue, failsValueMinLength, failsValueMaxLength, failsStepValue, failsPatternValue, failsValidator, isObjectArraySpec, isObjectSpec, isArraySpec } from "./validators.js";
 import { InvalidActionParamsError, ProblemDetailsError } from "./errors.js";
 import { alwaysArray } from "./utils/alwaysArray.js";
 import type { ImplementedAction } from "./actions/types.js";
@@ -46,13 +46,11 @@ export async function processAction<
   action,
 }: ProcessActionArgs<State, Spec>): Promise<ProcessActionResult<Spec>> {
   let httpStatus: number | null = null;
-  const payload: Partial<ActionPayload<Spec>> = {};
-  const transformers: Record<string, Promise<unknown>> = {};
-  const refs: ProblemDetailsParamsRefs = {};
+  const payload: Partial<ActionPayload<Spec>> = Object.create(null);
+  const transformers: Record<string, Promise<unknown>> = Object.create(null);
+  const refs: ProblemDetailsParamsRefs = Object.create(null);
   const appendProblemDetailsParam = makeAppendProblemDetails(refs);
 
-  console.log('SPEC', spec);
-
   let params: ParsedIRIValues;
   let query: ParsedIRIValues;
   let iriValues: IRIValue;
@@ -181,7 +179,7 @@ export async function processAction<
       });
 
       return null;
-    } else if (failValueMinLength(value, specValue)) {
+    } else if (failsValueMinLength(value, specValue)) {
       appendProblemDetailsParam({
         status: 400,
         param: {
@@ -192,7 +190,7 @@ export async function processAction<
       });
 
       return null;
-    } else if (failValueMaxLength(value, specValue)) {
+    } else if (failsValueMaxLength(value, specValue)) {
       appendProblemDetailsParam({
         status: 400,
         param: {
@@ -303,7 +301,6 @@ export async function processAction<
     }
 
     if (failsTypeRequirement(parentValue, specValue)) {
-      throw new Error('Nope');
       appendProblemDetailsParam({
         param: {
           name: paramName,
@@ -318,7 +315,7 @@ export async function processAction<
 
     const arrayValue = alwaysArray(parentValue);
 
-    if (failValueMinLength(arrayValue, specValue)) {
+    if (failsValueMinLength(arrayValue, specValue)) {
       appendProblemDetailsParam({
         param: {
           name: paramName,
@@ -329,7 +326,7 @@ export async function processAction<
       });
 
       return null;
-    } else if (failValueMaxLength(arrayValue, specValue)) {
+    } else if (failsValueMaxLength(arrayValue, specValue)) {
       appendProblemDetailsParam({
         param: {
           name: paramName,
@@ -464,7 +461,7 @@ export async function processAction<
 
     const arrayValue = alwaysArray(parentValue);
 
-    if (failValueMinLength(arrayValue, specValue)) {
+    if (failsValueMinLength(arrayValue, specValue)) {
       appendProblemDetailsParam({
         param: {
           name: paramName,
@@ -475,7 +472,7 @@ export async function processAction<
       });
 
       return null;
-    } else if (failValueMaxLength(arrayValue, specValue)) {
+    } else if (failsValueMaxLength(arrayValue, specValue)) {
       appendProblemDetailsParam({
         param: {
           name: paramName,

package/lib/utils/getRequestBodyValues.ts

@@ -23,7 +23,7 @@ export async function getRequestBodyValues<
   req: Request,
   action: ImplementedAction<State, Spec>,
 }): Promise<RequestBodyResult> {
-  let bodyValues: BodyValue = {};
+  let bodyValues: BodyValue = Object.create(null);
   const contentType = req.headers.get('content-type');
   const mappedTypes: Record<string, {
     term: string;
@@ -151,5 +151,7 @@ export async function getRequestBodyValues<
     bodyValues = compacted as JSONObject;
   }
 
+  Object.freeze(bodyValues);
+
   return { bodyValues };
 }

package/lib/utils/getRequestIRIValues.ts

@@ -40,12 +40,12 @@ export function getRequestIRIValues<
   iri: string;
   action: ImplementedAction<State, Spec>;
 }): RequestIRIResult<Spec> {
-  const pathValues: ParsedIRIValues = {};
-  const queryValues: ParsedIRIValues = {};
+  const pathValues: ParsedIRIValues = Object.create(null);
+  const queryValues: ParsedIRIValues = Object.create(null);
   // deno-lint-ignore no-explicit-any
-  const iriValues = {} as IRIValue<any>;
+  const iriValues = Object.create(null) as IRIValue<any>;
   const urlPatternResult = action.pattern.exec(iri);
-  const pathParams = urlPatternResult?.pathname.groups || {};
+  const pathParams = urlPatternResult?.pathname.groups || Object.create(null);
   const searchParams = new URL(iri).searchParams;
 
   const valueNames = Object.values<PropertySpec>(action.spec)

package/lib/validators.ts

@@ -36,7 +36,7 @@ export function failsRequiredRequirement(
   value: JSONValue,
   specValue: PropertySpec,
 ) {
-  return specValue.valueRequired && (typeof value === 'undefined' || value === null);
+  return specValue.valueRequired && value == null;
 }
 
 export function failsTypeRequirement(
@@ -146,7 +146,7 @@ export function failsPatternValue(value: JSONValue, specValue: PropertySpec) {
   return !regexp.test(value);
 }
 
-export function failValueMinLength(value: JSONValue, specValue: PropertySpec) {
+export function failsValueMinLength(value: JSONValue, specValue: PropertySpec) {
   if (typeof specValue.valueMinLength !== 'number') {
     return false;
   }
@@ -158,7 +158,7 @@ export function failValueMinLength(value: JSONValue, specValue: PropertySpec) {
   return true;
 }
 
-export function failValueMaxLength(value: JSONValue, specValue: PropertySpec) {
+export function failsValueMaxLength(value: JSONValue, specValue: PropertySpec) {
   if (typeof specValue.valueMaxLength !== 'number') {
     return false;
   }
@@ -184,3 +184,4 @@ export function failsValidator(
 
   return !validator(value);
 }
+

package/package.json

@@ -5,8 +5,8 @@
   "homepage": "https://github.com/occultist-dev/occultist",
   "license": "MIT",
   "type": "module",
-  "main": "dist/occultist.ts",
-  "types": "dist/occultist.d.ts",
+  "main": "dist/mod.js",
+  "types": "dist/mod.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/occultist-dev/occultist.git"
@@ -34,7 +34,7 @@
     "jsonld": "^9.0.0",
     "typescript": "^5.9.3"
   },
-  "version": "0.0.1",
+  "version": "0.0.3",
   "scripts": {
     "build": "tsc"
   }