@appsemble/types 0.20.42 → 0.20.43

package/LICENSE.md

@@ -0,0 +1,126 @@
+# GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright © 2018 Appsemble B.V. <https://appsemble.com>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing
+it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of
+version 3 of the GNU General Public License, supplemented by the additional permissions listed
+below.
+
+## 0. Additional Definitions.
+
+As used herein, _“this License”_ refers to version 3 of the GNU Lesser General Public License, and
+the _“GNU GPL”_ refers to version 3 of the GNU General Public License.
+
+_“The Library”_ refers to a covered work governed by this License, other than an Application or a
+Combined Work as defined below.
+
+An _“Application”_ is any work that makes use of an interface provided by the Library, but which is
+not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed
+a mode of using an interface provided by the Library.
+
+A _“Combined Work”_ is a work produced by combining or linking an Application with the Library. The
+particular version of the Library with which the Combined Work was made is also called the _“Linked
+Version”_.
+
+The _“Minimal Corresponding Source”_ for a Combined Work means the Corresponding Source for the
+Combined Work, excluding any source code for portions of the Combined Work that, considered in
+isolation, are based on the Application, and not on the Linked Version.
+
+The _“Corresponding Application Code”_ for a Combined Work means the object code and/or source code
+for the Application, including any data and utility programs needed for reproducing the Combined
+Work from the Application, but excluding the System Libraries of the Combined Work.
+
+## 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without being bound by section
+3 of the GNU GPL.
+
+## 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or
+data to be supplied by an Application that uses the facility (other than as an argument passed when
+the facility is invoked), then you may convey a copy of the modified version:
+
+- a) under this License, provided that you make a good faith effort to ensure that, in the event an
+  Application does not supply the function or data, the facility still operates, and performs
+  whatever part of its purpose remains meaningful, or
+- b) under the GNU GPL, with none of the additional permissions of this License applicable to that
+  copy.
+
+## 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header file that is part of
+the Library. You may convey such object code under terms of your choice, provided that, if the
+incorporated material is not limited to numerical parameters, data structure layouts and accessors,
+or small macros, inline functions and templates (ten or fewer lines in length), you do both of the
+following:
+
+- a) Give prominent notice with each copy of the object code that the Library is used in it and that
+  the Library and its use are covered by this License.
+- b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+## 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not
+restrict modification of the portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of the following:
+
+- a) Give prominent notice with each copy of the Combined Work that the Library is used in it and
+  that the Library and its use are covered by this License.
+- b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+- c) For a Combined Work that displays copyright notices during execution, include the copyright
+  notice for the Library among these notices, as well as a reference directing the user to the
+  copies of the GNU GPL and this license document.
+- d) Do one of the following:
+  1. Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding
+     Application Code in a form suitable for, and under terms that permit, the user to recombine or
+     relink the Application with a modified version of the Linked Version to produce a modified
+     Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding
+     Source.
+  2. Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is
+     one that (a) uses at run time a copy of the Library already present on the user’s computer
+     system, and (b) will operate properly with a modified version of the Library that is
+     interface-compatible with the Linked Version.
+- e) Provide Installation Information, but only if you would otherwise be required to provide such
+  information under section 6 of the GNU GPL, and only to the extent that such information is
+  necessary to install and execute a modified version of the Combined Work produced by recombining
+  or relinking the Application with a modified version of the Linked Version. (If you use option
+  4d0, the Installation Information must accompany the Minimal Corresponding Source and
+  Corresponding Application Code. If you use option 4d1, you must provide the Installation
+  Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding
+  Source.)
+
+## 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by side in a single
+library together with other library facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your choice, if you do both of the
+following:
+
+- a) Accompany the combined library with a copy of the same work based on the Library, uncombined
+  with any other library facilities, conveyed under the terms of this License.
+- b) Give prominent notice with the combined library that part of it is a work based on the Library,
+  and explaining where to find the accompanying uncombined form of the same work.
+
+## 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General
+Public License from time to time. Such new versions will be similar in spirit to the present
+version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies
+that a certain numbered version of the GNU Lesser General Public License _“or any later version”_
+applies to it, you have the option of following the terms and conditions either of that published
+version or of any later version published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser General Public License, you may
+choose any version of the GNU Lesser General Public License ever published by the Free Software
+Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the
+GNU Lesser General Public License shall apply, that proxy’s public statement of acceptance of any
+version is permanent authorization for you to choose that version for the Library.

package/README.md

@@ -1,11 +1,17 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.42/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.43/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.42/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.42)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.43/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.43)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
 ## Installation
 
 ```sh
@@ -20,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.42/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.43/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -1,5 +1,5 @@
-import { HTTPMethods } from './http.js';
-import { Remapper } from './index.js';
+import { type HTTPMethods } from './http.js';
+import { type Remapper } from './index.js';
 interface BaseAction<T extends string> {
     /**
      * A function which can be called to dispatch the action.

package/appMember.d.ts

@@ -1,5 +1,5 @@
-import { IconName } from '@fortawesome/fontawesome-common-types';
-import { App } from './index.js';
+import { type IconName } from '@fortawesome/fontawesome-common-types';
+import { type App } from './index.js';
 export interface SSOConfiguration {
     type: 'oauth2' | 'saml';
     url: string;

package/index.d.ts

@@ -1,12 +1,12 @@
-import { IconName } from '@fortawesome/fontawesome-common-types';
-import { Schema } from 'jsonschema';
-import { OpenAPIV3 } from 'openapi-types';
-import { JsonObject, RequireExactlyOne } from 'type-fest';
-import { Action, LogAction } from './action.js';
-import { AppVisibility, TeamsDefinition } from './app.js';
-import { BulmaColor } from './bulma.js';
-import { HTTPMethods } from './http.js';
-import { Theme } from './theme.js';
+import { type IconName } from '@fortawesome/fontawesome-common-types';
+import { type Schema } from 'jsonschema';
+import { type OpenAPIV3 } from 'openapi-types';
+import { type JsonObject, type RequireExactlyOne } from 'type-fest';
+import { type Action, type LogAction } from './action.js';
+import { type AppVisibility, type TeamsDefinition } from './app.js';
+import { type BulmaColor } from './bulma.js';
+import { type HTTPMethods } from './http.js';
+import { type Theme } from './theme.js';
 export * from './action.js';
 export * from './app.js';
 export * from './appMember.js';
@@ -264,6 +264,14 @@ export interface Remappers {
      * Returns `true` if all entries are equal, otherwise `false`.
      */
     equals: Remapper[];
+    /**
+     * Compare all computed remapper values against the first.
+     *
+     * Returns `false` if all entries are equal to the first entry, otherwise `true`.
+     *
+     * If only 1 or less are passed to it `false` is returned.
+     */
+    not: Remapper[];
     /**
      * Get data stored at the current flow page step
      */
@@ -280,6 +288,12 @@ export interface Remappers {
      * Returns `true` of the first entry is less than the second entry.
      */
     lt: [Remapper, Remapper];
+    /**
+     * Logs its input data (returns it) and its context.
+     *
+     * The value to set is the log level.
+     */
+    log: 'error' | 'info' | 'warn';
     /**
      * Builds an array based on the given data and remappers.
      *
@@ -313,6 +327,15 @@ export interface Remappers {
         then: Remapper;
         else: Remapper;
     };
+    /**
+     * Check if any case results in a truthy value.
+     *
+     * Returns the value of the first case where the condition equals true, otherwise returns null.
+     */
+    match: {
+        case: Remapper;
+        value: Remapper;
+    }[];
     /**
      * Get the current array.map’s index or length.
      *
@@ -1767,6 +1790,37 @@ export interface OAuth2Provider {
      */
     scope: string;
 }
+export type ServiceAuthenticationMethod = 'client-certificate' | 'client-credentials' | 'cookie' | 'custom-header' | 'http-basic' | 'query-parameter';
+export interface AppServiceSecret {
+    /**
+     * An autogenerated ID.
+     */
+    id?: number;
+    /**
+     * An optional name to give extra clarity what the secret is used for.
+     */
+    serviceName?: string;
+    /**
+     * The url pattern that is matched when a proxied request action is called.
+     */
+    urlPatterns: string;
+    /**
+     * The method to authenticate the request action with.
+     */
+    authenticationMethod: ServiceAuthenticationMethod;
+    /**
+     * The parameter name, header name, username or certificate that goes with the secret.
+     */
+    identifier?: string;
+    /**
+     * The secret to authenticate the proxied outgoing request with.
+     */
+    secret?: string;
+    /**
+     * The tokenUrl used for client-credentials method.
+     */
+    tokenUrl?: string;
+}
 export interface AppOAuth2Secret extends OAuth2Provider {
     /**
      * An autogenerated ID.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.20.42",
+  "version": "0.20.43",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",

package/snapshot.d.ts

@@ -1,4 +1,4 @@
-import { Author } from './author.js';
+import { type Author } from './author.js';
 /**
  * A snapshot of an app.
  */

package/template.d.ts

@@ -1,4 +1,4 @@
-import { AppVisibility } from './app.js';
+import { type AppVisibility } from './app.js';
 export interface Template {
     /**
      * The id of the app to clone.