@protobase/config 0.0.0-stage → 0.49.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/config.d.ts

@@ -0,0 +1,108 @@
+import { AdminOptions, AppIdentity, AssistantOptions, AuthSettings, AuthenticateSettings, EventsOptions, FileProviderSettings, FilesOptions, HistoryOptions, JobDeclaration, MobileConfig, NotificationsOptions, WebhooksOptions } from "@protobase/server";
+//#region src/config.d.ts
+/**
+ * `auth`: sign-in (see `AuthSettings`). Its URL, secrets and name are the app's (`url`, `secret`, `previousSecrets`,
+ * `name`), and so are its signing keys' (`signingKeyDays`, `signingKeyGraceDays`).
+ */
+export type AuthConfig = Omit<AuthSettings, 'baseURL' | 'secret' | 'appName' | 'previousSecrets' | 'signingKeyDays' | 'signingKeyGraceDays'>;
+/** `files`: where file fields keep their bytes (see `FilesOptions`), with the providers as data. */
+export type FilesConfig = Omit<FilesOptions, 'providers' | 'sharp'> & {
+  /**
+   * Providers by name: `{ kind: 'local', dir }`, `{ kind: 's3', bucket }`, or `{ kind: 'custom' }`, the default export
+   * of `files/<name>.ts`. Name the role (`archive`), not the vendor.
+   */
+  providers?: Record<string, FileProviderSettings | {
+    kind: 'custom';
+  }>;
+  /** The image library of image fields' variants and placeholders, by its package name, loaded when the app serves. */
+  images?: 'sharp';
+};
+/** The app itself: its name, address, secret, language, time zone and colours. */
+type AppKeys = AppIdentity & {
+  /** The app's name: sign-in prompts, the mail it sends, the tab titles and the installed app; `PROTOBASE_APP_NAME` overrides it. Default `Protobase`. */
+  name?: string;
+  /**
+   * The app's public URL, such as `https://admin.example.com`: the issuer of its tokens and where its emails link to.
+   * Default `PROTOBASE_URL`, or in `protobase dev` the dev server's own; required with sign-in otherwise.
+   */
+  url?: string;
+  /**
+   * The app's secret, made with `openssl rand -base64 32`: it signs session cookies, upload tickets and download links
+   * and public forms' bot checks, and encrypts the token signing keys. Default `PROTOBASE_SECRET`; required with sign-in.
+   */
+  secret?: string;
+  /**
+   * The app's secrets before `secret`, newest first: what they encrypted still decrypts, so the token signing keys keep
+   * signing after the secret changes. Keep one listed while the keys it encrypted sign (`signingKeyDays`), and while
+   * two-factor authenticator apps set up with it are in use. Default `PROTOBASE_PREVIOUS_SECRETS`, comma separated.
+   */
+  previousSecrets?: string[];
+  /** Days a token signing key signs before a new one takes over. Default 30. */
+  signingKeyDays?: number;
+  /** Days a replaced signing key still verifies the tokens it signed. Default 7, at least 1. */
+  signingKeyGraceDays?: number;
+  /** The language of the admin app's built-in screens and of its numbers and dates, for every user: `'en'` or `'nl'`; unset, each user's browser's. */
+  locale?: NonNullable<AdminOptions['locale']>;
+  /** The time zone the jobs' schedules are read in unless a job names its own, such as `Europe/Amsterdam`. Default `UTC`. */
+  timezone?: string;
+};
+/** The API's options (see `AdminOptions`), as data, four of them renamed so they read plainly beside the rest. */
+type ApiOptionKeys = Omit<AdminOptions, 'basePath' | 'roles' | 'writeHooks' | 'audit' | 'onUnhandledError' | 'assistant' | 'locale' | 'mcp' | 'runtime' | 'sources'> & {
+  /** The path of the REST API; default `/api/v1` (`AdminOptions['basePath']`). */
+  apiPath?: AdminOptions['basePath'];
+  /** The write hooks by name, run in this order inside each write's transaction; each is `hooks/<name>.ts`. */
+  writeHooks?: string[];
+  assistant?: Omit<AssistantOptions, 'tools' | 'fetch'> | false;
+  /** The MCP endpoint's tools: `sql`, `writes`, or `false` for a host that serves its own (`AdminOptions['mcp']`); `auth.mcp` turns MCP on. */
+  mcpEndpoint?: AdminOptions['mcp'];
+  /** The runtime updates endpoint behind the top bar's update button (`AdminOptions['runtime']`). */
+  runtimeUpdates?: AdminOptions['runtime'];
+  /** Other Protobase APIs whose resources the admin app draws as its own (`AdminOptions['sources']`). */
+  remoteResources?: AdminOptions['sources'];
+};
+/**
+ * What `protobase.config.ts` (or `protobase.config.json`) describes: one flat object of plain data, everything optional.
+ * The project's code is found by its path: resources in `config/`, roles in `config/roles.ts`, functions in
+ * `functions/`, each job's run in `jobs/<name>.ts`, each write hook in `hooks/<name>.ts`, and the auth hooks in
+ * `auth/hooks.ts`, among others (see the config reference). The database is `DATABASE_URL`'s.
+ */
+export type ProtobaseConfig = AppKeys & ApiOptionKeys & {
+  /**
+   * Sign-in (see `AuthConfig`), on by default with its own defaults; `false` turns it off, as does an
+   * `authenticate.jwksUrl` that trusts an auth server elsewhere. Its hooks are `auth/hooks.ts`.
+   */
+  auth?: AuthConfig | false;
+  /** How the API verifies tokens; default the tokens of `auth` (see `AuthenticateSettings`). */
+  authenticate?: AuthenticateSettings;
+  /** The app's jobs by name: what each does, its arguments and when it runs; its run is `jobs/<name>.ts`. */
+  jobs?: Record<string, JobDeclaration>;
+  files?: FilesConfig;
+  /** Where the changes that resources' events are raised from are captured (see `EventsOptions`). */
+  events?: EventsOptions;
+  /** How long the history of resources with `.history()` is kept (see `HistoryOptions`). */
+  history?: HistoryOptions;
+  /** Webhook subscriptions made in the admin app (see `WebhooksOptions`); `{}` turns them on. */
+  webhooks?: Omit<WebhooksOptions, 'ownerRoles'>;
+  /** Each user's devices and inbox (see `NotificationsOptions`); `{}` turns them on. */
+  notifications?: Omit<NotificationsOptions, 'store' | 'historyStore' | 'senders'>;
+  /** The app's iOS and Android build (see `MobileConfig`). */
+  mobile?: MobileConfig;
+};
+/**
+ * Which command reads the config: `dev`, `build`, `serve` (also a worker and a bundle's migrations), or `tool`, any
+ * other command over the project, such as `migration`, `users` or `doctor`.
+ */
+export type ConfigCommand = 'dev' | 'build' | 'serve' | 'tool';
+/** What a config function is called with. */
+export type ConfigEnv = {
+  command: ConfigCommand;
+  /** The environment: `process.env`, with the project's .env loaded. */
+  env: Record<string, string | undefined>;
+  /** The project's folder. */
+  root: string;
+};
+/** A config, or a function of the `ConfigEnv` that returns one, at once or as a promise. */
+export type ConfigFunction = (configEnv: ConfigEnv) => ProtobaseConfig | Promise<ProtobaseConfig>;
+/** What `protobase.config.ts` default-exports. */
+export type ConfigInput = ProtobaseConfig | ConfigFunction;
+//#endregion

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { AuthConfig, ConfigCommand, ConfigEnv, ConfigFunction, ConfigInput, FilesConfig, ProtobaseConfig } from "./config.js";
+//#region src/index.d.ts
+/**
+ * Types `protobase.config.ts`'s default export and returns it as it is: a config, or a function of the command and the
+ * environment that returns one, at once or as a promise.
+ */
+export declare function defineConfig(config: ProtobaseConfig): ProtobaseConfig;
+export declare function defineConfig(config: ConfigFunction): ConfigFunction;
+//#endregion
+export type { AuthConfig, ConfigCommand, ConfigEnv, ConfigFunction, ConfigInput, FilesConfig, ProtobaseConfig };

package/dist/index.js

@@ -0,0 +1,6 @@
+//#region src/index.ts
+function defineConfig(config) {
+	return config;
+}
+//#endregion
+export { defineConfig };

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@protobase/config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.49.1",
+  "description": "defineConfig and the types of a Protobase project's protobase.config.ts.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PrototeamHQ/protobase.git",
+    "directory": "packages/config"
+  },
+  "homepage": "https://docs.protobase.net",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@protobase/server": "0.49.1"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-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.