@valiantys/atlassian-app 3.2.0-alpha-1

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

@@ -0,0 +1,51 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CorsOptions } from 'cors';
+import { EntityStorageApi } from '@forge/storage/out/storage-adapter';
+import { Express as Express_2 } from 'express';
+import { Predicate } from '@forge/storage/out/storage-adapter';
+import { QueryApi } from '@forge/storage/out/storage-adapter';
+import { startsWith } from '@forge/storage/out';
+import { StorageAdapter } from '@forge/storage/out/storage-adapter';
+import { WhereConditions } from '@forge/storage/out';
+import { WherePredicate } from '@forge/storage/out/storage-adapter';
+
+// Warning: (ae-forgotten-export) The symbol "Product" needs to be exported by the entry point backend-feature-atlassian-app-express.d.ts
+// Warning: (ae-forgotten-export) The symbol "ResolverFunctionFactory" needs to be exported by the entry point backend-feature-atlassian-app-express.d.ts
+// Warning: (ae-forgotten-export) The symbol "ExpressConfig" needs to be exported by the entry point backend-feature-atlassian-app-express.d.ts
+// Warning: (ae-forgotten-export) The symbol "ForgeStorageConfig" needs to be exported by the entry point backend-feature-atlassian-app-express.d.ts
+//
+// @public (undocumented)
+export function bootstrapExpress<P extends Product>(functionFactory: ResolverFunctionFactory<P>, product: P, oAuthConfig: {
+    clientId: string;
+    clientSecret: string;
+}, expressConfig?: ExpressConfig, storageConfig?: ForgeStorageConfig, httpsOptions?: {
+    key: string;
+    cert: string;
+}, defineAdditionalHandlers?: (app: Express_2) => void): void;
+
+// @public (undocumented)
+export function defineResolverFunctionExpressJsHandlers<P extends Product>(app: Express_2, prefix: string, functionFactory: ResolverFunctionFactory<P>, product: P, storageConfig?: ForgeStorageConfig): void;
+
+// @public (undocumented)
+export function defineStandaloneSpecificExpressJsHandlers(app: Express_2, prefix: string, oAuthConfig: {
+    clientId: string;
+    clientSecret: string;
+}): void;
+
+// @public
+export const expressDefaults: ExpressConfig;
+
+// @public (undocumented)
+export const forgeStorageDefaults: ForgeStorageConfig;
+
+// @public (undocumented)
+export function makePath(prefix: string, path: string): string;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/backend-feature-atlassian-app-express/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express/index.cjs.js");exports.bootstrapExpress=e.bootstrapExpress;exports.defineResolverFunctionExpressJsHandlers=e.defineResolverFunctionExpressJsHandlers;exports.defineStandaloneSpecificExpressJsHandlers=e.defineStandaloneSpecificExpressJsHandlers;exports.expressDefaults=e.expressDefaults;exports.forgeStorageDefaults=e.forgeStorageDefaults;exports.makePath=e.makePath;

package/backend-feature-atlassian-app-express/index.d.ts

@@ -0,0 +1,141 @@
+import { CorsOptions } from 'cors';
+import { EntityStorageApi } from '@forge/storage/out/storage-adapter';
+import { Express as Express_2 } from 'express';
+import { Predicate } from '@forge/storage/out/storage-adapter';
+import { QueryApi } from '@forge/storage/out/storage-adapter';
+import { startsWith } from '@forge/storage/out';
+import { StorageAdapter } from '@forge/storage/out/storage-adapter';
+import { WhereConditions } from '@forge/storage/out';
+import { WherePredicate } from '@forge/storage/out/storage-adapter';
+
+declare interface AccountContext {
+    accountId: string;
+}
+
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+declare interface AtlassianProductFetchService<P extends Product> {
+    productType: P;
+    fetch: FetchSignature;
+    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
+    rawFetch: RequestProductMethod;
+    fullUrl: (path: string) => string;
+}
+
+export declare function bootstrapExpress<P extends Product>(functionFactory: ResolverFunctionFactory<P>, product: P, oAuthConfig: {
+    clientId: string;
+    clientSecret: string;
+}, expressConfig?: ExpressConfig, storageConfig?: ForgeStorageConfig, httpsOptions?: {
+    key: string;
+    cert: string;
+}, defineAdditionalHandlers?: (app: Express_2) => void): void;
+
+export declare function defineResolverFunctionExpressJsHandlers<P extends Product>(app: Express_2, prefix: string, functionFactory: ResolverFunctionFactory<P>, product: P, storageConfig?: ForgeStorageConfig): void;
+
+export declare function defineStandaloneSpecificExpressJsHandlers(app: Express_2, prefix: string, oAuthConfig: {
+    clientId: string;
+    clientSecret: string;
+}): void;
+
+declare interface ExpressConfig {
+    port: number;
+    prefix: string;
+    corsOptions: CorsOptions;
+}
+
+/**
+ * Default Values are:
+ * {
+ *   port: 3000,
+ *   prefix: 'api',
+ *   corsOptions: { origin: ['http://localhost:4201', 'http://localhost:4200'] },
+ * }
+ */
+export declare const expressDefaults: ExpressConfig;
+
+declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+declare interface FetchRequest {
+    method: FetchMethod;
+    url: FetchRoute;
+    responseType?: 'json' | 'text';
+    allowExperimental?: boolean;
+}
+
+declare type FetchRoute = {
+    readonly value: string;
+};
+
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
+
+declare interface ForgeRequest<T, U extends AccountContext = AccountContext> {
+    payload: T;
+    context: U;
+}
+
+declare type ForgeResolverFunction<P, R, C extends AccountContext = AccountContext> = (request: ForgeRequest<P, C>) => Promise<R> | R;
+
+declare interface ForgeStorageConfig {
+    indexFieldMapping: Record<string, string>;
+    filePath: string;
+}
+
+export declare const forgeStorageDefaults: ForgeStorageConfig;
+
+declare interface ForgeStorageService {
+    storage: EntityStorageApi & StorageAdapter & QueryApi;
+    /**
+     * Used in entity query where clauses
+     * ex.  where(WhereConditions.isGreaterThan(30))
+     */
+    WhereConditions: typeof WhereConditions;
+    /**
+     * Used in key-value query
+     * ex. where('key', startsWith('value'))
+     */
+    startsWith: typeof startsWith;
+}
+
+declare class ForgeStorageServiceStandalone implements ForgeStorageService {
+    private indexFieldMapping;
+    private readonly secrets;
+    private readonly keyValues;
+    private readonly entityCollections;
+    readonly storage: EntityStorageApi & StorageAdapter & QueryApi;
+    constructor(indexFieldMapping: Record<string, string>, initialValues?: ForgeStorageStandaloneData);
+    WhereConditions: {
+        beginsWith: (value: string | number) => WherePredicate;
+        between: (values: [string, string] | [number, number]) => WherePredicate;
+        equalsTo: (value: number | string | boolean) => WherePredicate;
+        isGreaterThan: (value: string | number) => WherePredicate;
+        isGreaterThanEqualTo: (value: string | number) => WherePredicate;
+        isLessThan: (value: string | number) => WherePredicate;
+        isLessThanEqualTo: (value: string | number) => WherePredicate;
+    };
+    startsWith: (value: string) => Predicate;
+    writeOut(): string;
+    addMissingCollections(collectionNames: string[]): void;
+}
+
+declare interface ForgeStorageStandaloneData {
+    secrets: Record<string, unknown>;
+    keyValues: Record<string, unknown>;
+    entityCollections: Record<string, Record<string, unknown>>;
+}
+
+export declare function makePath(prefix: string, path: string): string;
+
+declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+declare interface ResolverFunctionDefinition {
+    function: ForgeResolverFunction<any, any>;
+    updatesForgeStorage?: boolean;
+}
+
+declare type ResolverFunctionFactory<P extends Product> = (productFetchService: AtlassianProductFetchService<P>, forgeStorageService: ForgeStorageServiceStandalone) => ResolverFunctionMap;
+
+declare type ResolverFunctionMap<T extends string = string> = Record<T, ResolverFunctionDefinition>;
+
+export { }

package/backend-feature-atlassian-app-express/index.es.js

@@ -0,0 +1,9 @@
+import { bootstrapExpress as r, defineResolverFunctionExpressJsHandlers as a, defineStandaloneSpecificExpressJsHandlers as o, expressDefaults as t, forgeStorageDefaults as n, makePath as f } from "../atlassian/shared/backend-feature-atlassian-app-express/src/lib/atlassian-app-backend-express/index.es.js";
+export {
+  r as bootstrapExpress,
+  a as defineResolverFunctionExpressJsHandlers,
+  o as defineStandaloneSpecificExpressJsHandlers,
+  t as expressDefaults,
+  n as forgeStorageDefaults,
+  f as makePath
+};

package/backend-feature-atlassian-app-express/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}