@valiantys/atlassian-app 3.2.0-alpha-1

package/backend-feature-atlassian-app-express/atlassian-app-backend-feature-atlassian-app-express.api.json

@@ -0,0 +1,682 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.8",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@valiantys/atlassian-app!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!bootstrapExpress:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function bootstrapExpress<P extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Product",
+              "canonicalReference": "@valiantys/atlassian-app!~Product:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">(functionFactory: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ResolverFunctionFactory",
+              "canonicalReference": "@valiantys/atlassian-app!~ResolverFunctionFactory:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<P>"
+            },
+            {
+              "kind": "Content",
+              "text": ", product: "
+            },
+            {
+              "kind": "Content",
+              "text": "P"
+            },
+            {
+              "kind": "Content",
+              "text": ", oAuthConfig: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    clientId: string;\n    clientSecret: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ", expressConfig?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExpressConfig",
+              "canonicalReference": "@valiantys/atlassian-app!~ExpressConfig:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", storageConfig?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ForgeStorageConfig",
+              "canonicalReference": "@valiantys/atlassian-app!~ForgeStorageConfig:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", httpsOptions?: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    key: string;\n    cert: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ", defineAdditionalHandlers?: "
+            },
+            {
+              "kind": "Content",
+              "text": "(app: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Express",
+              "canonicalReference": "@types/express!e.Express:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 20,
+            "endIndex": 21
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "functionFactory",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "product",
+              "parameterTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "oAuthConfig",
+              "parameterTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "expressConfig",
+              "parameterTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 11
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "storageConfig",
+              "parameterTypeTokenRange": {
+                "startIndex": 12,
+                "endIndex": 13
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "httpsOptions",
+              "parameterTypeTokenRange": {
+                "startIndex": 14,
+                "endIndex": 15
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "defineAdditionalHandlers",
+              "parameterTypeTokenRange": {
+                "startIndex": 16,
+                "endIndex": 19
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "P",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "bootstrapExpress"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!defineResolverFunctionExpressJsHandlers:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function defineResolverFunctionExpressJsHandlers<P extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Product",
+              "canonicalReference": "@valiantys/atlassian-app!~Product:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">(app: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Express",
+              "canonicalReference": "@types/express!e.Express:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", prefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", functionFactory: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ResolverFunctionFactory",
+              "canonicalReference": "@valiantys/atlassian-app!~ResolverFunctionFactory:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<P>"
+            },
+            {
+              "kind": "Content",
+              "text": ", product: "
+            },
+            {
+              "kind": "Content",
+              "text": "P"
+            },
+            {
+              "kind": "Content",
+              "text": ", storageConfig?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ForgeStorageConfig",
+              "canonicalReference": "@valiantys/atlassian-app!~ForgeStorageConfig:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 14,
+            "endIndex": 15
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "app",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "prefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "functionFactory",
+              "parameterTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 9
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "product",
+              "parameterTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 11
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "storageConfig",
+              "parameterTypeTokenRange": {
+                "startIndex": 12,
+                "endIndex": 13
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "P",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "defineResolverFunctionExpressJsHandlers"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!defineStandaloneSpecificExpressJsHandlers:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function defineStandaloneSpecificExpressJsHandlers(app: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Express",
+              "canonicalReference": "@types/express!e.Express:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", prefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", oAuthConfig: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    clientId: string;\n    clientSecret: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 7,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "app",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "prefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "oAuthConfig",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "defineStandaloneSpecificExpressJsHandlers"
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@valiantys/atlassian-app!expressDefaults:var",
+          "docComment": "/**\n * Default Values are: { port: 3000, prefix: 'api', corsOptions: { origin: ['http://localhost:4201', 'http://localhost:4200'] }, }\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "expressDefaults: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExpressConfig",
+              "canonicalReference": "@valiantys/atlassian-app!~ExpressConfig:interface"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "expressDefaults",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@valiantys/atlassian-app!forgeStorageDefaults:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "forgeStorageDefaults: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ForgeStorageConfig",
+              "canonicalReference": "@valiantys/atlassian-app!~ForgeStorageConfig:interface"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "forgeStorageDefaults",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!makePath:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function makePath(prefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", path: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "prefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "path",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "makePath"
+        }
+      ]
+    }
+  ]
+}