@ohos-ports/layer0-prefetch 4.20.0-beta.0 → 4.20.0-beta.1

package/node_modules/@layer0/core/constants.d.ts

@@ -0,0 +1,214 @@
+/**
+ * Layer0 configuration file name.
+ */
+export declare const LAYER0_CONFIG_FILE = "layer0.config.js";
+/**
+ * Indicate asset files that need to be uploaded under a different
+ * bucket key.
+ * It contains values like
+ * {
+ *   '/posts' => '/posts/index.html'
+ * }
+ */
+export declare const LAYER0_ASSET_ALIASES_FILE = "asset-aliases.json";
+/**
+ * Environment variables used by Layer0.
+ */
+export declare const LAYER0_ENV_VARIABLES: {
+    /**
+     * Layer0 configuration environment variable key.
+     */
+    config: string;
+    /**
+     * Indicates whether code is running locally or in the cloud.
+     * @private
+     */
+    deploymentType: string;
+    /**
+     * Allows Layer0 development team to easily override Layer0 version
+     * during development process.
+     * @private
+     */
+    versionOverride: string;
+};
+/**
+ * Indicates that code is running in AWS.
+ * @private
+ */
+export declare const LAYER0_DEPLOYMENT_TYPE_AWS = "AWS";
+/**
+ * Prefix of all Layer0 headers.
+ */
+export declare const LAYER0_HEADERS_PREFIX = "x-0-";
+/**
+ * Maximum number of user headers allowed by Layer0 platform.
+ *
+ * We limit the request and response headers allowed to 70. This is due to a limitation that edge has
+ * which at the moment supports up to 96 headers. Edge provider itself needs to use some of those headers
+ * with the remainder used by our edge code.
+ *
+ * NOTE: This constant must be equal ot the constant of the same name defined in Layer0 buffer proxy.
+ * NOTE: If this constant is updated then the constant of the same name has to be updated in @layer0/build-lambda module.
+ */
+export declare const LAYER0_MAX_USER_HEADERS_ALLOWED = 70;
+/**
+ * Status code returned when there are too many request or response headers.
+ *
+ * Must be equal to HeaderOverflowError status code as defined in build lambda and Layer0 buffer proxy.
+ */
+export declare const LAYER0_TOO_MANY_HEADERS_STATUS_CODE = 542;
+/**
+ * The status code returned when the layer0_prefetch query param is present and a response could not be found in the cache.
+ */
+export declare const LAYER0_UNCACHED_PREFETCH_STATUS = 412;
+/**
+ * CDN-as-code configuration actions
+ */
+export declare const ACTIONS: {
+    setHeader: string;
+    updateHeader: string;
+    removeHeader: string;
+    syntheticRes: string;
+    updatePath: string;
+    proxy: string;
+    addCookie: string;
+    updateCookie: string;
+    removeCookie: string;
+};
+/**
+ * The backend for cloud functions
+ */
+export declare const BACKENDS: {
+    js: string;
+    static: string;
+    permanentStatic: string;
+    imageOptimizer: string;
+};
+/**
+ * The hostname used for the internal service running the user's application.
+ */
+export declare const JS_BACKEND_HOSTNAME = "127.0.0.1";
+export declare const HTTP_METHODS: {
+    head: string;
+    get: string;
+    post: string;
+    delete: string;
+    put: string;
+    patch: string;
+    options: string;
+};
+/**
+ * Common HTTP headers.
+ */
+export declare const HTTP_HEADERS: {
+    acceptEncoding: string;
+    authorization: string;
+    cacheControl: string;
+    contentEncoding: string;
+    contentLength: string;
+    contentType: string;
+    cookie: string;
+    host: string;
+    location: string;
+    serverTiming: string;
+    setCookie: string;
+    userAgent: string;
+    vary: string;
+    via: string;
+    x0Browser: string;
+    x0CacheControl: string;
+    x0CacheVersion: string;
+    x0CachingStatus: string;
+    x0ClientIp: string;
+    x0Components: string;
+    x0Destination: string;
+    x0Device: string;
+    x0DeviceIsBot: string;
+    x0GeoCity: string;
+    x0GeoCountryCode: string;
+    x0GeoLatitude: string;
+    x0GeoLongitude: string;
+    x0GeoPostalCode: string;
+    x0MatchedRoutes: string;
+    x0Protocol: string;
+    x0Route: string;
+    x0Status: string;
+    x0SurrogateKey: string;
+    x0T: string;
+    x0UserT: string;
+    x0Vendor: string;
+    x0Version: string;
+    xForwardedFor: string;
+    xRequestId: string;
+    xSwCacheControl: string;
+};
+/**
+ * Values for x-0-caching-status
+ */
+export declare const CACHING_STATUS: {
+    ok: string;
+    private: string;
+    method: string;
+    bodyTooBig: string;
+    code: string;
+    setCookie: string;
+    noMaxAge: string;
+};
+export declare const CACHEABLE_METHODS: Set<string>;
+/**
+ * When present, this query parameter will cause Layer0 to return a 412 status
+ * if a response could not be found in the cache.
+ */
+export declare const THROTTLED_QUERY_PARAM = "layer0_prefetch";
+/**
+ * Same value as above but DEPRECATED.
+ */
+export declare const PREFETCH_QUERY_PARAM = "layer0_prefetch";
+/**
+ Adds query parameter with custom maxAgeSecond value for service-worker cache if it's specified in PrefetchConfiguration
+ */
+export declare const PREFETCH_TTL_PARAM = "layer0_prefetch_ttl";
+/**
+ Labels the request so that devtools will display as prefetched
+ */
+export declare const DEVTOOLS_PREFETCH_QUERY_PARAM = "layer0_dt_pf";
+/**
+ * The name of the query parameter used to detect HEAD requests.
+ */
+export declare const HEAD_QUERY_PARAM = "layer0_head";
+/**
+ * The name of the query parameter used for the body of POST requests, which is used for the cache key
+ */
+export declare const POST_BODY_QUERY_PARAM = "pref_layer0_body";
+/**
+ * The name of the query parameter used for the method of requests, which is used for the cache key
+ */
+export declare const METHOD_QUERY_PARAM = "pref_layer0_method";
+/**
+ * Route Group name, which is used in router for fallback routes
+ */
+export declare const ROUTES_FALLBACK = "fallback";
+/**
+ * Route Group name, which is used in router for error page routes
+ */
+export declare const ROUTES_CATCH_GROUP = "catch";
+/**
+ * Route Group name, which is used in router for noindex routes
+ */
+export declare const ROUTES_NOINDEX_GROUP = "noindex";
+/**
+ * The path for the built-in image optimizer.
+ */
+export declare const LAYER0_IMAGE_OPTIMIZER_PATH = "/__layer0_image_optimizer";
+/**
+ * Is current environment 'browser'
+ */
+export declare const IS_BROWSER: boolean;
+/**
+ * Brotli encoding code.
+ */
+export declare const BROTLI_ENCODING = "br";
+/**
+ * Gzip encoding code.
+ */
+export declare const GZIP_ENCODING = "gzip";

package/node_modules/@layer0/core/constants.js

@@ -0,0 +1,216 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Layer0 configuration file name.
+ */
+exports.LAYER0_CONFIG_FILE = 'layer0.config.js';
+/**
+ * Indicate asset files that need to be uploaded under a different
+ * bucket key.
+ * It contains values like
+ * {
+ *   '/posts' => '/posts/index.html'
+ * }
+ */
+exports.LAYER0_ASSET_ALIASES_FILE = 'asset-aliases.json';
+/**
+ * Environment variables used by Layer0.
+ */
+exports.LAYER0_ENV_VARIABLES = {
+    /**
+     * Layer0 configuration environment variable key.
+     */
+    config: 'LAYER0_CONFIG',
+    /**
+     * Indicates whether code is running locally or in the cloud.
+     * @private
+     */
+    deploymentType: 'LAYER0_DEPLOYMENT_TYPE',
+    /**
+     * Allows Layer0 development team to easily override Layer0 version
+     * during development process.
+     * @private
+     */
+    versionOverride: 'LAYER0_VERSION_OVERRIDE',
+};
+/**
+ * Indicates that code is running in AWS.
+ * @private
+ */
+exports.LAYER0_DEPLOYMENT_TYPE_AWS = 'AWS';
+/**
+ * Prefix of all Layer0 headers.
+ */
+exports.LAYER0_HEADERS_PREFIX = 'x-0-';
+/**
+ * Maximum number of user headers allowed by Layer0 platform.
+ *
+ * We limit the request and response headers allowed to 70. This is due to a limitation that edge has
+ * which at the moment supports up to 96 headers. Edge provider itself needs to use some of those headers
+ * with the remainder used by our edge code.
+ *
+ * NOTE: This constant must be equal ot the constant of the same name defined in Layer0 buffer proxy.
+ * NOTE: If this constant is updated then the constant of the same name has to be updated in @layer0/build-lambda module.
+ */
+exports.LAYER0_MAX_USER_HEADERS_ALLOWED = 70;
+/**
+ * Status code returned when there are too many request or response headers.
+ *
+ * Must be equal to HeaderOverflowError status code as defined in build lambda and Layer0 buffer proxy.
+ */
+exports.LAYER0_TOO_MANY_HEADERS_STATUS_CODE = 542;
+/**
+ * The status code returned when the layer0_prefetch query param is present and a response could not be found in the cache.
+ */
+exports.LAYER0_UNCACHED_PREFETCH_STATUS = 412;
+/**
+ * CDN-as-code configuration actions
+ */
+exports.ACTIONS = {
+    setHeader: 'set-header',
+    updateHeader: 'update-header',
+    removeHeader: 'remove-header',
+    syntheticRes: 'synthetic-response',
+    updatePath: 'update-path',
+    proxy: 'proxy',
+    addCookie: 'add-cookie',
+    updateCookie: 'update-cookie',
+    removeCookie: 'remove-cookie',
+};
+/**
+ * The backend for cloud functions
+ */
+exports.BACKENDS = {
+    js: '__js__',
+    static: '__static__',
+    permanentStatic: '__permanent_static__',
+    imageOptimizer: '__image_optimizer__',
+};
+/**
+ * The hostname used for the internal service running the user's application.
+ */
+exports.JS_BACKEND_HOSTNAME = '127.0.0.1';
+exports.HTTP_METHODS = {
+    head: 'head',
+    get: 'get',
+    post: 'post',
+    delete: 'delete',
+    put: 'put',
+    patch: 'patch',
+    options: 'options',
+};
+/**
+ * Common HTTP headers.
+ */
+exports.HTTP_HEADERS = {
+    acceptEncoding: 'accept-encoding',
+    authorization: 'authorization',
+    cacheControl: 'cache-control',
+    contentEncoding: 'content-encoding',
+    contentLength: 'content-length',
+    contentType: 'content-type',
+    cookie: 'cookie',
+    host: 'host',
+    location: 'location',
+    serverTiming: 'server-timing',
+    setCookie: 'set-cookie',
+    userAgent: 'user-agent',
+    vary: 'vary',
+    via: 'via',
+    x0Browser: 'x-0-browser',
+    x0CacheControl: 'x-0-cache-control',
+    x0CacheVersion: 'x-0-cache-version',
+    x0CachingStatus: 'x-0-caching-status',
+    x0ClientIp: 'x-0-client-ip',
+    x0Components: 'x-0-components',
+    x0Destination: 'x-0-destination',
+    x0Device: 'x-0-device',
+    x0DeviceIsBot: 'x-0-device-is-bot',
+    x0GeoCity: 'x-0-geo-city',
+    x0GeoCountryCode: 'x-0-geo-country-code',
+    x0GeoLatitude: 'x-0-geo-latitude',
+    x0GeoLongitude: 'x-0-geo-longitude',
+    x0GeoPostalCode: 'x-0-geo-postal-code',
+    x0MatchedRoutes: 'x-0-matched-routes',
+    x0Protocol: 'x-0-protocol',
+    x0Route: 'x-0-route',
+    x0Status: 'x-0-status',
+    x0SurrogateKey: 'x-0-surrogate-key',
+    x0T: 'x-0-t',
+    x0UserT: 'x-0-user-t',
+    x0Vendor: 'x-0-vendor',
+    x0Version: 'x-0-version',
+    xForwardedFor: 'x-forwarded-for',
+    xRequestId: 'x-request-id',
+    xSwCacheControl: 'x-sw-cache-control',
+};
+/**
+ * Values for x-0-caching-status
+ */
+exports.CACHING_STATUS = {
+    ok: 'ok',
+    private: 'private',
+    method: 'method',
+    bodyTooBig: 'body-too-big',
+    code: 'code',
+    setCookie: 'set-cookie',
+    noMaxAge: 'no-max-age',
+};
+exports.CACHEABLE_METHODS = new Set(['get', 'head']);
+/**
+ * When present, this query parameter will cause Layer0 to return a 412 status
+ * if a response could not be found in the cache.
+ */
+exports.THROTTLED_QUERY_PARAM = 'layer0_prefetch';
+/**
+ * Same value as above but DEPRECATED.
+ */
+exports.PREFETCH_QUERY_PARAM = exports.THROTTLED_QUERY_PARAM;
+/**
+ Adds query parameter with custom maxAgeSecond value for service-worker cache if it's specified in PrefetchConfiguration
+ */
+exports.PREFETCH_TTL_PARAM = 'layer0_prefetch_ttl';
+/**
+ Labels the request so that devtools will display as prefetched
+ */
+exports.DEVTOOLS_PREFETCH_QUERY_PARAM = 'layer0_dt_pf';
+/**
+ * The name of the query parameter used to detect HEAD requests.
+ */
+exports.HEAD_QUERY_PARAM = 'layer0_head';
+/**
+ * The name of the query parameter used for the body of POST requests, which is used for the cache key
+ */
+exports.POST_BODY_QUERY_PARAM = 'pref_layer0_body';
+/**
+ * The name of the query parameter used for the method of requests, which is used for the cache key
+ */
+exports.METHOD_QUERY_PARAM = 'pref_layer0_method';
+/**
+ * Route Group name, which is used in router for fallback routes
+ */
+exports.ROUTES_FALLBACK = 'fallback';
+/**
+ * Route Group name, which is used in router for error page routes
+ */
+exports.ROUTES_CATCH_GROUP = 'catch';
+/**
+ * Route Group name, which is used in router for noindex routes
+ */
+exports.ROUTES_NOINDEX_GROUP = 'noindex';
+/**
+ * The path for the built-in image optimizer.
+ */
+exports.LAYER0_IMAGE_OPTIMIZER_PATH = '/__layer0_image_optimizer';
+/**
+ * Is current environment 'browser'
+ */
+exports.IS_BROWSER = typeof window !== 'undefined';
+/**
+ * Brotli encoding code.
+ */
+exports.BROTLI_ENCODING = 'br';
+/**
+ * Gzip encoding code.
+ */
+exports.GZIP_ENCODING = 'gzip';

package/node_modules/@layer0/core/context.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This module provides a context that can be used to store request
+ * state. For example, accumulating timing metrics from various layers
+ * during the life of the request.
+ */
+declare global {
+    module NodeJS {
+        interface Global {
+            __layer0_timings__: SingletonContext;
+        }
+    }
+}
+/**
+ * Runs the specified callback within the specified context
+ * @param cb
+ */
+export declare function withContext(cb: () => Promise<any>): any;
+/**
+ * Gets a value from the current context
+ * @param key The name of the variable to get
+ * @param defaultValue A default value to set and return if no value is found.
+ */
+export declare function get(key: string, defaultValue: any): any;
+/**
+ * Sets a value on the current context
+ * @param key The variable to set
+ * @param value The value to store
+ */
+export declare function set(key: string, value: any): void;
+/**
+ *
+ */
+declare class SingletonContext {
+    values: any;
+    get(key: string): any;
+    set(key: string, value: any): void;
+}
+export {};

package/node_modules/@layer0/core/context.js

@@ -0,0 +1,98 @@
+"use strict";
+/**
+ * This module provides a context that can be used to store request
+ * state. For example, accumulating timing metrics from various layers
+ * during the life of the request.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const environment_1 = require("./environment");
+const nonWebpackRequire_1 = __importDefault(require("./utils/nonWebpackRequire"));
+const CONTEXT = 'layer0';
+let clsNamespace;
+/**
+ * Runs the specified callback within the specified context
+ * @param cb
+ */
+function withContext(cb) {
+    if (environment_1.isLocal()) {
+        return createClsNamespace().runAndReturn(cb);
+    }
+    else {
+        global.__layer0_timings__ = new SingletonContext();
+        return cb();
+    }
+}
+exports.withContext = withContext;
+/**
+ * Returns the current context.
+ */
+function getContext() {
+    return global.__layer0_timings__ || getClsNamespace();
+}
+/**
+ * Creates a new CLS-hooked namespace
+ */
+function createClsNamespace() {
+    const cls = nonWebpackRequire_1.default('cls-hooked');
+    if (!clsNamespace) {
+        clsNamespace = cls.createNamespace(CONTEXT);
+    }
+    return clsNamespace;
+}
+/**
+ * Gets the current CLS-hooked namespace
+ */
+function getClsNamespace() {
+    return nonWebpackRequire_1.default('cls-hooked').getNamespace(CONTEXT);
+}
+/**
+ * Gets a value from the current context
+ * @param key The name of the variable to get
+ * @param defaultValue A default value to set and return if no value is found.
+ */
+function get(key, defaultValue) {
+    try {
+        const context = getContext();
+        let value = context.get(key);
+        if (value == null) {
+            value = defaultValue;
+            context.set(key, defaultValue);
+        }
+        return value;
+    }
+    catch (e) {
+        return defaultValue;
+    }
+}
+exports.get = get;
+/**
+ * Sets a value on the current context
+ * @param key The variable to set
+ * @param value The value to store
+ */
+function set(key, value) {
+    try {
+        getContext().set(key, value);
+    }
+    catch (e) {
+        throw new Error('set must be called within withContext');
+    }
+}
+exports.set = set;
+/**
+ *
+ */
+class SingletonContext {
+    constructor() {
+        this.values = {};
+    }
+    get(key) {
+        return this.values[key];
+    }
+    set(key, value) {
+        this.values[key] = value;
+    }
+}

package/node_modules/@layer0/core/default-app/all/layer0.config.js

@@ -0,0 +1,60 @@
+// This file was automatically added by layer0 init.
+// You should commit this file to source control.
+// Learn more about this file at https://docs.layer0.co/guides/layer0_config
+module.exports = {
+  backends: {
+    origin: {
+      // The domain name or IP address of the origin server
+      domainOrIp: 'example.com',
+
+      // When provided, the following value will be sent as the host header when connecting to the origin.
+      // If omitted, the host header from the browser will be forwarded to the origin.
+      hostHeader: 'example.com',
+
+      // Uncomment the following line if TLS is not set up properly on the origin domain and you want to ignore TLS errors
+      // disableCheckCert: true,
+
+      // Overrides the default ports (80 for http and 443 for https) and instead use a specific port
+      // when connecting to the origin
+      // port: 1337,
+    },
+  },
+
+  // The name of the site in Layer0 to which this app should be deployed.
+  // name: 'my-site-name',
+
+  // The name of the team in Layer0 to which this app should be deployed.
+  // team: 'my-team-name',
+
+  // Overrides the default path to the routes file. The path should be relative to the root of your app.
+  // routes: 'routes.js',
+
+  // The maximum number of URLs that will be concurrently prerendered during deployment when static prerendering is enabled.
+  // Defaults to 200, which is the maximum allowed value.
+  // prerenderConcurrency: 200,
+
+  // A list of glob patterns identifying which source files should be uploaded when running layer0 deploy --includeSources.
+  // This option is primarily used to share source code with Layer0 support personnel for the purpose of debugging. If omitted,
+  // layer0 deploy --includeSources will result in all files which are not gitignored being uploaded to Layer0.
+  //
+  // sources : [
+  //   '**/*', // include all files
+  //   '!(**/secrets/**/*)', // except everything in the secrets directory
+  // ],
+
+  // Allows you to include additional resources in the bundle that is deployed to Layer0’s serverless JS workers.
+  // Keys are globs, value can be a boolean or string. This is typically used to ensure that resources
+  // that need to be dynamically required at runtime such as build manifests for server-side rendering
+  // or other config files are present in the cloud.
+  //
+  // includeFiles: {
+  //   'lang/**/*': true, // Just includes the specified files
+  //   'content/**/*': 'another/dir/in/layer0/lambda', // Copies the files into specific directory within Layer0 build
+  // },
+
+  // Set to true to include all packages listed in the dependencies property of package.json when deploying to Layer0.
+  // This option generally isn't needed as Layer0 automatically includes all modules imported by your code in the bundle that
+  // is uploaded during deployment
+  //
+  // includeNodeModules: true,
+}

package/node_modules/@layer0/core/default-app/js/routes.js

@@ -0,0 +1,27 @@
+// This file was added by layer0 init.
+// You should commit this file to source control.
+
+import { Router } from '@layer0/core/router'
+
+// const ONE_HOUR = 60 * 60
+// const ONE_DAY = 24 * ONE_HOUR
+
+export default new Router()
+
+  // Here is an example where we cache api/* at the edge but prevent caching in the browser
+  // .match('/api/:path*', ({ proxy, cache }) => {
+  //   cache({
+  //     edge: {
+  //       maxAgeSeconds: ONE_DAY,
+  //       staleWhileRevalidateSeconds: ONE_HOUR,
+  //     },
+  //     browser: {
+  //       maxAgeSeconds: 0,
+  //       serviceWorkerSeconds: ONE_DAY,
+  //     },
+  //   })
+  //   proxy('origin')
+  // })
+
+  // send any unmatched request to origin
+  .fallback(({ proxy }) => proxy('origin'))

package/node_modules/@layer0/core/default-app/ts/routes.ts

@@ -0,0 +1,27 @@
+// This file was added by layer0 init.
+// You should commit this file to source control.
+
+import { Router } from '@layer0/core/router'
+
+// const ONE_HOUR = 60 * 60
+// const ONE_DAY = 24 * ONE_HOUR
+
+export default new Router()
+
+  // Here is an example where we cache api/* at the edge but prevent caching in the browser
+  // .match('/api/:path*', ({ proxy, cache }) => {
+  //   cache({
+  //     edge: {
+  //       maxAgeSeconds: ONE_DAY,
+  //       staleWhileRevalidateSeconds: ONE_HOUR,
+  //     },
+  //     browser: {
+  //       maxAgeSeconds: 0,
+  //       serviceWorkerSeconds: ONE_DAY,
+  //     },
+  //   })
+  //   proxy('origin')
+  // })
+
+  // send any unmatched request to origin
+  .fallback(({ proxy }) => proxy('origin'))