@fastly/compute-js-context 0.5.1 → 0.5.3

package/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.5.3] - 2026-01-07
+
+### Added
+
+- Release using CI
+
+## [0.5.2] - 2025-10-16
+
+### Fixed
+
+- Updated README
+
 ## [0.5.1] - 2025-10-14
 
 ### Fixed
@@ -41,7 +53,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial public release
 
-[unreleased]: https://github.com/fastly/compute-js-context/compare/v0.5.1...HEAD
+[unreleased]: https://github.com/fastly/compute-js-context/compare/v0.5.3...HEAD
+[0.5.3]: https://github.com/fastly/compute-js-context/compare/v0.5.2...v0.5.3
+[0.5.2]: https://github.com/fastly/compute-js-context/compare/v0.5.1...v0.5.2
 [0.5.1]: https://github.com/fastly/compute-js-context/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/fastly/compute-js-context/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/fastly/compute-js-context/compare/v0.4.1...v0.4.2

package/README.md

@@ -124,16 +124,29 @@ Creates the main immutable `Context`. Each sub-object is a `Proxy` that:
 - **Returns `undefined`** for names that don’t exist (except for `ENV`, which returns `''`)
 - **Is not enumerable** by design (don’t rely on `Object.keys`)
 
-### `buildContextProxy<T>(context: Context, bindingsDefs: T): ContextProxy<T>`
+### `buildContextProxy<T>(bindingsDefs: T): ContextProxy<T>`
 
 Creates a custom, strongly-typed proxy object based on your definitions.
 
-- `context`: An instance of the main `Context` object
 - `bindingsDefs`: A `const` object defining your desired bindings
   - **Key**: The property name you want on your final `contextProxy` object
   - **Value**: A string in the format `'ResourceType'` or `'ResourceType:actual-name'`
 - **Returns**: A proxy object `contextProxy` with your custom bindings. Accessing a property on this object looks up the resource from the main `Context`
 
+### Type `ContentProxy<T>`
+
+Defines a type that represents the content proxy, inferred from your bindings definitions.
+
+### (Advanced) `buildContextProxyOn<C, T>(target: C, bindingsDefs: T): C & ContextProxy<T>`
+
+Extends the passed-in object with a custom, strongly-typed proxy object based on your definitions.
+
+- `target`: An object to extend
+- `bindingsDefs`: A `const` object defining your desired bindings
+  - **Key**: The property name you want on your final `contextProxy` object
+  - **Value**: A string in the format `'ResourceType'` or `'ResourceType:actual-name'`
+- **Returns**: A proxy object `contextProxy` that extends `target` with your custom bindings. Accessing a property on this object looks up the resource from the main `Context` before falling back to `target`.
+
 ### Context Categories & Shapes
 
 > These are the raw shapes available on the main `Context` object.
@@ -152,7 +165,6 @@ Creates a custom, strongly-typed proxy object based on your definitions.
 - **Don’t mutate** the context or its sub-objects; it’s intentionally `Readonly`
 - **Expect `undefined`** for missing resources and code accordingly (`?.`/guard)
 
-
 ## Issues
 
 If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug] using the bug report template.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastly/compute-js-context",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Surfaces Fastly Compute environment as a context object",
   "license": "MIT",
   "repository": {

package/build/bindings.d.ts

@@ -1,37 +0,0 @@
-import type { Acl } from 'fastly:acl';
-import type { Backend } from 'fastly:backend';
-import type { ConfigStore } from 'fastly:config-store';
-import type { KVStore } from 'fastly:kv-store';
-import type { Logger } from 'fastly:logger';
-import type { SecretStore } from 'fastly:secret-store';
-import type { Context } from './index.js';
-type Def<T extends string> = T | `${T}:${string}`;
-type Defs<T extends string> = T extends string ? Def<T> : never;
-declare const BindingStringToContextKeyMapping: {
-    readonly Acl: "ACLS";
-    readonly Backend: "BACKENDS";
-    readonly ConfigStore: "CONFIG_STORES";
-    readonly env: "ENV";
-    readonly KVStore: "KV_STORES";
-    readonly Logger: "LOGGERS";
-    readonly SecretStore: "SECRET_STORES";
-};
-export type ResourceType = keyof typeof BindingStringToContextKeyMapping;
-export type BindingsString = Defs<ResourceType>;
-export type EnvBindingsDefs = Record<string, BindingsString>;
-type BindingStringToResourceInstanceTypeMapping = {
-    Acl: Acl;
-    Backend: Backend;
-    ConfigStore: ConfigStore;
-    env: string;
-    KVStore: KVStore;
-    Logger: Logger;
-    SecretStore: SecretStore;
-};
-export type ResourceInstance<T> = T extends Def<infer K extends keyof BindingStringToResourceInstanceTypeMapping> ? BindingStringToResourceInstanceTypeMapping[K] : never;
-export type BuildBindings<T extends EnvBindingsDefs> = {
-    [K in keyof T]: ResourceInstance<T[K]>;
-};
-export declare function buildEnvironment<T extends EnvBindingsDefs>(context: Context, envBindingsDefs: T): BuildBindings<T>;
-export {};
-//# sourceMappingURL=bindings.d.ts.map

package/build/bindings.js

@@ -1,52 +0,0 @@
-const BindingStringToContextKeyMapping = {
-    Acl: 'ACLS',
-    Backend: 'BACKENDS',
-    ConfigStore: 'CONFIG_STORES',
-    env: 'ENV',
-    KVStore: 'KV_STORES',
-    Logger: 'LOGGERS',
-    SecretStore: 'SECRET_STORES',
-};
-function isResourceType(resourceType) {
-    return resourceType in BindingStringToContextKeyMapping;
-}
-function getResourceType(typeName) {
-    const [resourceType,] = typeName.split(':');
-    if (isResourceType(resourceType)) {
-        return resourceType;
-    }
-    return undefined;
-}
-function getResourceName(key, typeName) {
-    const [, seg,] = typeName.split(':');
-    return seg ?? key;
-}
-export function buildEnvironment(context, envBindingsDefs) {
-    const target = {};
-    const getEntry = (key) => {
-        if (typeof key !== "string") {
-            return undefined;
-        }
-        const typeName = envBindingsDefs[key];
-        const resourceType = getResourceType(typeName);
-        if (resourceType == null) {
-            return undefined;
-        }
-        const resourceName = getResourceName(key, typeName);
-        const contextKey = BindingStringToContextKeyMapping[resourceType];
-        const contextEntry = context[contextKey];
-        if (contextEntry == null) {
-            return undefined;
-        }
-        return contextEntry[resourceName];
-    };
-    const handler = {
-        get(_, key) {
-            return getEntry(key);
-        },
-        has(_, key) {
-            return getEntry(key) !== undefined;
-        },
-    };
-    return new Proxy(target, handler);
-}