@aldel/test-func-kit 0.0.0-stage → 0.0.2

package/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "google",
+    "plugin:@typescript-eslint/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: ["tsconfig.json", "tsconfig.dev.json"],
+    sourceType: "module",
+  },
+  ignorePatterns: [
+    "/lib/**/*", // Ignore built files.
+    "/generated/**/*", // Ignore generated files.
+  ],
+  plugins: [
+    "@typescript-eslint",
+    "import",
+  ],
+  rules: {
+    "quotes": ["error", "double"],
+    "import/no-unresolved": 0,
+    "indent": ["error", 2],
+  },
+};

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# test-func-kit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A minimal, experimental Firebase Function Kit.

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Import function triggers from their respective submodules:
+ *
+ * import {onCall} from "firebase-functions/v2/https";
+ * import {onDocumentWritten} from "firebase-functions/v2/firestore";
+ *
+ * See a full list of supported triggers at https://firebase.google.com/docs/functions
+ */
+export declare const helloWorld: import("firebase-functions/https").HttpsFunction;

package/lib/index.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * Import function triggers from their respective submodules:
+ *
+ * import {onCall} from "firebase-functions/v2/https";
+ * import {onDocumentWritten} from "firebase-functions/v2/firestore";
+ *
+ * See a full list of supported triggers at https://firebase.google.com/docs/functions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helloWorld = void 0;
+const firebase_functions_1 = require("firebase-functions");
+const https_1 = require("firebase-functions/https");
+const params_1 = require("firebase-functions/params");
+// import * as logger from "firebase-functions/logger";
+const message = (0, params_1.defineString)('MESSAGE', {
+    label: 'Message sent by the helloWorld function',
+    description: 'The message to be sent by the helloWorld function. Must begin with "Hello".',
+    default: 'Hello, World!',
+    input: {
+        text: {
+            validationRegex: /^Hello\b/i,
+            validationErrorMessage: 'Must begin with "Hello"',
+        },
+    },
+});
+// Start writing functions
+// https://firebase.google.com/docs/functions/typescript
+// For cost control, you can set the maximum number of containers that can be
+// running at the same time. This helps mitigate the impact of unexpected
+// traffic spikes by instead downgrading performance. This limit is a
+// per-function limit. You can override the limit for each function using the
+// `maxInstances` option in the function's options, e.g.
+// `onRequest({ maxInstances: 5 }, (req, res) => { ... })`.
+// NOTE: setGlobalOptions does not apply to functions using the v1 API. V1
+// functions should each use functions.runWith({ maxInstances: 10 }) instead.
+// In the v1 API, each function can only serve one request per container, so
+// this will be the maximum concurrent request count.
+(0, firebase_functions_1.setGlobalOptions)({ maxInstances: 10 });
+exports.helloWorld = (0, https_1.onRequest)((request, response) => {
+    console.log("Hello logs!", { structuredData: true });
+    response.send(message.value());
+});
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "@aldel/test-func-kit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "A minimal, experimental function kit for Firebase.",
+  "version": "0.0.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "eslint --ext .js,.ts .",
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "serve": "npm run build && firebase emulators:start --only functions",
+    "shell": "npm run build && firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log",
+    "prepack": "npm run build"
+  },
+  "engines": {
+    "node": "24"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "dependencies": {
+    "firebase-admin": "^13.6.0",
+    "firebase-functions": "^7.0.0"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^8.57.0",
+    "eslint-config-google": "^0.14.0",
+    "eslint-plugin-import": "^2.25.4",
+    "firebase-functions-test": "^3.4.1",
+    "typescript": "^6.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,49 @@
+/**
+ * Import function triggers from their respective submodules:
+ *
+ * import {onCall} from "firebase-functions/v2/https";
+ * import {onDocumentWritten} from "firebase-functions/v2/firestore";
+ *
+ * See a full list of supported triggers at https://firebase.google.com/docs/functions
+ */
+
+import {setGlobalOptions} from "firebase-functions";
+import {onRequest} from "firebase-functions/https";
+import { defineString } from 'firebase-functions/params';
+// import * as logger from "firebase-functions/logger";
+
+const message = defineString(
+  'MESSAGE',
+  {
+    label: 'Message sent by the helloWorld function',
+    description: 'The message to be sent by the helloWorld function. Must begin with "Hello".',
+    default: 'Hello, World!',
+    input: {
+      text: {
+        validationRegex: /^Hello\b/i,
+        validationErrorMessage: 'Must begin with "Hello"',
+      },
+    },
+  },
+);
+
+
+// Start writing functions
+// https://firebase.google.com/docs/functions/typescript
+
+// For cost control, you can set the maximum number of containers that can be
+// running at the same time. This helps mitigate the impact of unexpected
+// traffic spikes by instead downgrading performance. This limit is a
+// per-function limit. You can override the limit for each function using the
+// `maxInstances` option in the function's options, e.g.
+// `onRequest({ maxInstances: 5 }, (req, res) => { ... })`.
+// NOTE: setGlobalOptions does not apply to functions using the v1 API. V1
+// functions should each use functions.runWith({ maxInstances: 10 }) instead.
+// In the v1 API, each function can only serve one request per container, so
+// this will be the maximum concurrent request count.
+setGlobalOptions({maxInstances: 10});
+
+export const helloWorld = onRequest((request, response) => {
+  console.log("Hello logs!", {structuredData: true});
+  response.send(message.value());
+});

package/tsconfig.dev.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "noEmit": true
+  },
+  "include": [
+    ".eslintrc.js"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "declaration": true,
+    "esModuleInterop": true,
+    "moduleResolution": "nodenext",
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "outDir": "lib",
+    "rootDir": "src",
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2017",
+    "skipLibCheck": true
+  },
+  "compileOnSave": true,
+  "include": [
+    "src"
+  ]
+}