@resolution/jira-api-client 0.1.6 → 0.3.0

package/lib/openapi/software/models/remoteLinks.d.ts

@@ -0,0 +1,268 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type IssueKey, type Properties, type ProviderMetadata } from "./common";
+/**
+ * IssueKeysAssociation
+ *
+ * An association type referencing issues in Jira.
+ *
+ * @example {
+ *     "associationType": "issueKeys",
+ *     "values": [
+ *         "ABC-123",
+ *         "ABC-456"
+ *     ]
+ * }
+ */
+export interface IssueKeysAssociation extends Record<string, unknown> {
+    /**
+     * Defines the asssociation type.
+     *
+     * @example issueKeys
+     */
+    associationType: "issueKeys";
+    /**
+     * The Jira issue keys to associate the Remote Link information with.
+     *
+     * The number of values counted across all associationTypes (issueKeys,
+     * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+     */
+    values: IssueKey[];
+}
+/**
+ * RemoteLinkData
+ *
+ * Data related to a single Remote Link.
+ */
+export interface RemoteLinkData extends Record<string, unknown> {
+    /**
+     * The schema version used for this data.
+     *
+     * Placeholder to support potential schema changes in the future.
+     *
+     * @example 1
+     */
+    schemaVersion?: "1.0";
+    /**
+     * The identifier for the Remote Link. Must be unique for a given Provider.
+     *
+     * @example 111-222-333
+     */
+    id: string;
+    /**
+     * An ID used to apply an ordering to updates for this Remote Link in the case of
+     * out-of-order receipt of
+     * update requests.
+     *
+     * It must be a monotonically increasing number. For example, epoch time could be
+     * one way to generate the
+     * `updateSequenceNumber`.
+     *
+     * Updates for a Remote Link that is received with an `updateSqeuenceNumber` less
+     * than or equal to what is currently
+     * stored will be ignored.
+     *
+     * @example 1523494301448
+     */
+    updateSequenceNumber: number;
+    /**
+     * The human-readable name for the Remote Link.
+     *
+     * Will be shown in the UI.
+     *
+     * @example Remote Link #42
+     */
+    displayName: string;
+    /** The URL to this Remote Link in your system. */
+    url: string;
+    /**
+     * The type of the Remote Link. The current supported types are 'document',
+     * 'alert', 'test',
+     * 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'
+     *
+     * @example security
+     */
+    type: "document" | "alert" | "test" | "security" | "logFile" | "prototype" | "coverage" | "bugReport" | "other";
+    /**
+     * An optional description to attach to this Remote Link.
+     *
+     * This may be anything that makes sense in your system.
+     *
+     * @example Remote Link #42 with more information in this description
+     */
+    description?: string;
+    /**
+     * The last-updated timestamp to present to the user as a summary of when Remote
+     * Link was last updated.
+     *
+     * @example 2018-01-20T23:27:25.000Z
+     */
+    lastUpdated: string;
+    /** The entities to associate the Remote Link information with. */
+    associations?: (({
+        /**
+         * Defines the asssociation type.
+         *
+         * @example issueKeys
+         */
+        associationType: "issueKeys";
+        /**
+         * The Jira issue keys to associate the Remote Link information with.
+         *
+         * The number of values counted across all associationTypes (issueKeys,
+         * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+         */
+        values: string[];
+    } & {
+        [key: string]: unknown;
+    }) | ({
+        /**
+         * Defines the asssociation type.
+         *
+         * @example serviceIdOrKeys
+         */
+        associationType: "serviceIdOrKeys";
+        /**
+         * The service id or keys to associate the Remote Link information with.
+         *
+         * The number of values counted across all associationTypes (issueKeys,
+         * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+         */
+        values: string[];
+    } & {
+        [key: string]: unknown;
+    }))[];
+    /**
+     * RemoteLinkStatus
+     *
+     * The status of a Remote Link.
+     */
+    status?: {
+        /**
+         * Appearance is a fixed set of appearance types affecting the colour
+         * of the status lozenge in the UI. The colours they correspond to are
+         * equivalent to atlaskit's
+         * [Lozenge](https://atlaskit.atlassian.com/packages/core/lozenge) component.
+         *
+         * @example inprogress
+         */
+        appearance: "default" | "inprogress" | "moved" | "new" | "removed" | "prototype" | "success";
+        /**
+         * The human-readable description for the Remote Link status.
+         *
+         * Will be shown in the UI.
+         *
+         * @example ANOMALOUS
+         */
+        label: string;
+    } & {
+        [key: string]: unknown;
+    };
+    /**
+     * Optional list of actionIds. They are associated with the actions the provider
+     * is able to provide when they
+     * registered. Indicates which actions this Remote Link has.
+     *
+     * If any actions have a templateUrl that requires string substitution, then
+     * `attributeMap` must be passed in.
+     *
+     * @example [
+     *     "action-111-222-333",
+     *     "action-444-555-666"
+     * ]
+     */
+    actionIds?: string[];
+    /**
+     * Map of key/values (string to string mapping). This is used to build the urls
+     * for actions from the
+     * templateUrl the provider registered their available actions with.
+     */
+    attributeMap?: {
+        [key: string]: string;
+    };
+}
+/**
+ * ServiceIdOrKeys
+ *
+ * A service id or service key.
+ *
+ * @example some-service-key
+ */
+export type ServiceIdOrKeys = string;
+/**
+ * ServiceIdOrKeysAssociation
+ *
+ * An association type referencing service id or keys.
+ *
+ * @example {
+ *     "associationType": "serviceIdOrKeys",
+ *     "values": [
+ *         "some-service-key"
+ *     ]
+ * }
+ */
+export interface ServiceIdOrKeysAssociation extends Record<string, unknown> {
+    /**
+     * Defines the asssociation type.
+     *
+     * @example serviceIdOrKeys
+     */
+    associationType: "serviceIdOrKeys";
+    /**
+     * The service id or keys to associate the Remote Link information with.
+     *
+     * The number of values counted across all associationTypes (issueKeys,
+     * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+     */
+    values: ServiceIdOrKeys[];
+}
+/**
+ * SubmitRemoteLinksRequest
+ *
+ * The payload used to submit (update / insert) Remote Link data.
+ */
+export interface SubmitRemoteLinksRequest extends Record<string, unknown> {
+    /**
+     * Properties
+     *
+     * Properties assigned to build data that can then be used for delete / query
+     * operations.
+     *
+     * Examples might be an account or user ID that can then be used to clean up data
+     * if an account is removed from
+     * the Provider system.
+     *
+     * Note that these properties will never be returned with build data. They are not
+     * intended for use as
+     * metadata to associate with a build. Internally they are stored as a hash so
+     * that personal information etc.
+     * is never stored within Jira.
+     *
+     * Properties are supplied as key/value pairs, a maximum of 5 properties can be
+     * supplied, and keys must not
+     * contain ':' or start with '_'.
+     *
+     * @example {
+     *     "accountId": "account-234",
+     *     "projectId": "project-123"
+     * }
+     */
+    properties?: Properties;
+    /**
+     * A list of Remote Links to submit to Jira.
+     *
+     * Each Remote Link may be associated with one or more Jira issue keys, and will
+     * be associated with any properties
+     * included in this request.
+     */
+    remoteLinks: RemoteLinkData[];
+    /**
+     * ProviderMetadata
+     *
+     * Information about the provider. This is useful for auditing, logging,
+     * debugging, and other internal uses. It is not considered private information.
+     * Hence, it may not contain personally identifiable information.
+     */
+    providerMetadata?: ProviderMetadata;
+}
+export declare function registerRemoteLinksValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

package/lib/openapi/software/models/remoteLinks.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerRemoteLinksValidationSchemas = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const common_1 = require("./common");
+function registerRemoteLinksValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("IssueKeysAssociation", zod_1.z
+        .object({
+        associationType: zod_1.z.enum(["issueKeys"]),
+        values: zod_1.z
+            .array(validationSchemaStorage.lazy("IssueKey"))
+            .min(1)
+            .max(500),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("IssueKeysAssociation"));
+    validationSchemaStorage.register("RemoteLinkData", zod_1.z
+        .object({
+        schemaVersion: zod_1.z.enum(["1.0"]).optional(),
+        id: zod_1.z.string().max(255),
+        updateSequenceNumber: zod_1.z.number().int(),
+        displayName: zod_1.z.string().max(255),
+        url: zod_1.z.string().max(2000),
+        type: zod_1.z.enum([
+            "document",
+            "alert",
+            "test",
+            "security",
+            "logFile",
+            "prototype",
+            "coverage",
+            "bugReport",
+            "other",
+        ]),
+        description: zod_1.z.string().max(255).optional(),
+        lastUpdated: zod_1.z.string(),
+        associations: zod_1.z
+            .array(zod_1.z.union([
+            zod_1.z
+                .object({
+                associationType: zod_1.z.enum(["issueKeys"]),
+                values: zod_1.z
+                    .array(zod_1.z.string().regex(new RegExp("^\\w{1,255}-\\d{1,255}$")))
+                    .min(1)
+                    .max(500),
+            })
+                .catchall(zod_1.z.unknown()),
+            zod_1.z
+                .object({
+                associationType: zod_1.z.enum(["serviceIdOrKeys"]),
+                values: zod_1.z.array(zod_1.z.string().max(255)).min(1).max(500),
+            })
+                .catchall(zod_1.z.unknown()),
+        ]))
+            .min(1)
+            .max(2)
+            .optional(),
+        status: zod_1.z
+            .object({
+            appearance: zod_1.z.enum([
+                "default",
+                "inprogress",
+                "moved",
+                "new",
+                "removed",
+                "prototype",
+                "success",
+            ]),
+            label: zod_1.z.string().max(255),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+        actionIds: zod_1.z.array(zod_1.z.string()).max(10).optional(),
+        attributeMap: zod_1.z.object({}).catchall(zod_1.z.string()).optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("RemoteLinkData"));
+    validationSchemaStorage.register("ServiceIdOrKeys", zod_1.z.string().max(255).describe("ServiceIdOrKeys"));
+    validationSchemaStorage.register("ServiceIdOrKeysAssociation", zod_1.z
+        .object({
+        associationType: zod_1.z.enum(["serviceIdOrKeys"]),
+        values: zod_1.z
+            .array(validationSchemaStorage.lazy("ServiceIdOrKeys"))
+            .min(1)
+            .max(500),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("ServiceIdOrKeysAssociation"));
+    validationSchemaStorage.register("SubmitRemoteLinksRequest", zod_1.z
+        .object({
+        properties: validationSchemaStorage.lazy("Properties").optional(),
+        remoteLinks: zod_1.z
+            .array(validationSchemaStorage.lazy("RemoteLinkData"))
+            .min(1)
+            .max(100),
+        providerMetadata: validationSchemaStorage
+            .lazy("ProviderMetadata")
+            .optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SubmitRemoteLinksRequest"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerRemoteLinksValidationSchemas = registerRemoteLinksValidationSchemas;
+//# sourceMappingURL=remoteLinks.js.map

package/lib/openapi/software/models/remoteLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteLinks.js","sourceRoot":"","sources":["../../../../src/openapi/software/models/remoteLinks.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAKkB;AA4RlB,SAAgB,oCAAoC,CAClD,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,EAAE,OAAC;aACN,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC/C,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;KACZ,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,gBAAgB,EAChB,OAAC;SACE,MAAM,CAAC;QACN,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE;QACzC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QACvB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACtC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QAChC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;QACzB,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC;YACX,UAAU;YACV,OAAO;YACP,MAAM;YACN,UAAU;YACV,SAAS;YACT,WAAW;YACX,UAAU;YACV,WAAW;YACX,OAAO;SACR,CAAC;QACF,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;QAC3C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,YAAY,EAAE,OAAC;aACZ,KAAK,CACJ,OAAC,CAAC,KAAK,CAAC;YACN,OAAC;iBACE,MAAM,CAAC;gBACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC;gBACtC,MAAM,EAAE,OAAC;qBACN,KAAK,CACJ,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,CAAC,CAAC,CACxD;qBACA,GAAG,CAAC,CAAC,CAAC;qBACN,GAAG,CAAC,GAAG,CAAC;aACZ,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;YACxB,OAAC;iBACE,MAAM,CAAC;gBACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC;gBAC5C,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;aACrD,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CACH;aACA,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;QACb,MAAM,EAAE,OAAC;aACN,MAAM,CAAC;YACN,UAAU,EAAE,OAAC,CAAC,IAAI,CAAC;gBACjB,SAAS;gBACT,YAAY;gBACZ,OAAO;gBACP,KAAK;gBACL,SAAS;gBACT,WAAW;gBACX,SAAS;aACV,CAAC;YACF,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;SAC3B,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;QACjD,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC3D,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,gBAAgB,CAAC,CAC9B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAChD,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,4BAA4B,EAC5B,OAAC;SACE,MAAM,CAAC;QACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC;QAC5C,MAAM,EAAE,OAAC;aACN,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aACtD,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;KACZ,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,4BAA4B,CAAC,CAC1C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,0BAA0B,EAC1B,OAAC;SACE,MAAM,CAAC;QACN,UAAU,EAAE,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;QACjE,WAAW,EAAE,OAAC;aACX,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACrD,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;QACX,gBAAgB,EAAE,uBAAuB;aACtC,IAAI,CAAC,kBAAkB,CAAC;aACxB,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,0BAA0B,CAAC,CACxC,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AAtHD,oFAsHC"}