@osdk/docs-spec-platform 0.8.0

package/build/esm/ir/Resource.d.ts

@@ -0,0 +1,103 @@
+import type { Documentation, Example, Locator } from "./Common.js";
+import type { Error as ApiError } from "./Error.js";
+import type { ParameterValue } from "./ParameterValue.js";
+export interface Resource {
+    component: Locator;
+    operations: Operation[];
+    pluralName: string;
+    documentation: Documentation;
+    singleton?: boolean;
+    pathSegment?: string;
+    idPropertyName?: string;
+    parentResource?: Locator;
+    relativeName?: string;
+    pluralRelativeName?: string;
+}
+export interface Operation {
+    name: string;
+    verb: string;
+    documentation?: Documentation;
+    http: Http;
+    auth: Auth;
+    auditCategories: string[];
+    releaseStage: undefined | "PUBLIC_BETA" | "PRIVATE_BETA" | "STABLE";
+    throwableErrors: ApiError[];
+}
+export type Http = {
+    path: string;
+    httpMethod: HttpMethod;
+    parameters: Parameter[];
+    requestBody?: RequestBody;
+    response: Response;
+    conjureServerAsync?: boolean;
+    conjureRequestContext?: boolean;
+};
+export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+export interface Auth {
+    includeAuthHeader: boolean;
+    scopes: string[];
+}
+export type InputType = "HEADER" | "PATH" | "QUERY" | "BODY";
+export interface Parameter {
+    name: string;
+    documentation: Documentation;
+    inputType: InputType;
+    type: ParameterValue;
+}
+export type MediaType = "application/json" | "*/*";
+export interface ComponentRequestType {
+    type: "component";
+    component: {
+        mediaType: MediaType;
+        type: ParameterValue;
+        example?: Example[];
+    };
+}
+export interface ComponentResponseType {
+    type: "component";
+    component: {
+        mediaType: MediaType;
+        type: ParameterValue;
+        example?: Example[];
+    };
+}
+export interface BinaryResponseType {
+    type: "binary";
+    binary: {
+        mediaType: string;
+    };
+}
+export interface NoContentResponseBody {
+    type: "noContent";
+    noContent: Record<string, never>;
+}
+export interface ReferenceResponseType {
+    mediaType: string;
+    type: ParameterValue;
+}
+export type ResponseType = ComponentResponseType | BinaryResponseType | ReferenceResponseType;
+export interface OkResponseBody {
+    type: "ok";
+    ok: {
+        responseType: ResponseType;
+        required: boolean;
+    };
+}
+export interface AcceptedResponseBody {
+    type: "accepted";
+    accepted: {
+        responseType: ResponseType;
+    };
+}
+export type ResponseBody = OkResponseBody | NoContentResponseBody | AcceptedResponseBody;
+export type RequestBodyType = ComponentRequestType | BinaryResponseType;
+export interface RequestBody {
+    body: RequestBodyType;
+    documentation?: Documentation;
+}
+export interface Response {
+    documentation?: Documentation;
+    body: ResponseBody;
+    code: string;
+}
+//# sourceMappingURL=Resource.d.ts.map

package/build/esm/ir/Resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.d.ts","sourceRoot":"","sources":["../../../src/ir/Resource.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,YAAY,EAAE,SAAS,GAAG,aAAa,GAAG,cAAc,GAAG,QAAQ,CAAC;IACpE,eAAe,EAAE,QAAQ,EAAE,CAAC;CAC7B;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErE,MAAM,WAAW,IAAI;IACnB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,SAAS,GACjB,QAAQ,GACR,MAAM,GACN,OAAO,GACP,MAAM,CAAC;AAEX,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAEnD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT,SAAS,EAAE,SAAS,CAAC;QACrB,IAAI,EAAE,cAAc,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT,SAAS,EAAE,SAAS,CAAC;QACrB,IAAI,EAAE,cAAc,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GACpB,qBAAqB,GACrB,kBAAkB,GAClB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE;QACF,YAAY,EAAE,YAAY,CAAC;QAC3B,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACR,YAAY,EAAE,YAAY,CAAC;KAC5B,CAAC;CACH;AAED,MAAM,MAAM,YAAY,GACpB,cAAc,GACd,qBAAqB,GACrB,oBAAoB,CAAC;AAEzB,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AAExE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,eAAe,CAAC;IACtB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,QAAQ;IACvB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd"}

package/build/esm/ir/Resource.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * 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.
+ */
+export {};
+//# sourceMappingURL=Resource.js.map

package/build/esm/ir/Resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.js","names":[],"sources":["Resource.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/build/esm/ir/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./ApiSpec.js";
+export * from "./BuiltInTypes.js";
+export * from "./Common.js";
+export * from "./Component.js";
+export * from "./DataTypes.js";
+export * from "./Error.js";
+export * from "./Namespace.js";
+export * from "./ParameterValue.js";
+export * from "./Resource.js";
+//# sourceMappingURL=index.d.ts.map

package/build/esm/ir/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ir/index.ts"],"names":[],"mappings":"AAgBA,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC"}

package/build/esm/ir/index.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2023 Palantir Technologies, Inc. All rights reserved.
+ *
+ * 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.
+ */
+export * from "./ApiSpec.js";
+export * from "./BuiltInTypes.js";
+export * from "./Common.js";
+export * from "./Component.js";
+export * from "./DataTypes.js";
+export * from "./Error.js";
+export * from "./Namespace.js";
+export * from "./ParameterValue.js";
+export * from "./Resource.js";
+//# sourceMappingURL=index.js.map

package/build/esm/ir/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["index.js"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nexport * from \"./ApiSpec.js\";\nexport * from \"./BuiltInTypes.js\";\nexport * from \"./Common.js\";\nexport * from \"./Component.js\";\nexport * from \"./DataTypes.js\";\nexport * from \"./Error.js\";\nexport * from \"./Namespace.js\";\nexport * from \"./ParameterValue.js\";\nexport * from \"./Resource.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,cAAc;AAC5B,cAAc,mBAAmB;AACjC,cAAc,aAAa;AAC3B,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,YAAY;AAC1B,cAAc,gBAAgB;AAC9B,cAAc,qBAAqB;AACnC,cAAc,eAAe","ignoreList":[]}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@osdk/docs-spec-platform",
+  "version": "0.8.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/foundry-platform-typescript.git"
+  },
+  "exports": {
+    ".": {
+      "browser": "./build/browser/index.js",
+      "import": "./build/esm/index.js",
+      "default": "./build/esm/index.js"
+    },
+    "./*": {
+      "browser": "./build/browser/public/*.js",
+      "import": "./build/esm/public/*.js",
+      "default": "./build/esm/public/*.js"
+    }
+  },
+  "dependencies": {
+    "@osdk/docs-spec-core": "0.5.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.4",
+    "@osdk/monorepo.tsconfig": "~0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/cjs",
+    "build/esm",
+    "build/browser",
+    "CHANGELOG.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "module": "./build/esm/index.js",
+  "types": "./build/esm/index.d.ts",
+  "sls": {
+    "dependencies": {
+      "com.palantir.foundry.api:api-gateway": {
+        "minVersion": "1.1157.0",
+        "maxVersion": "1.x.x",
+        "optional": false
+      }
+    }
+  },
+  "type": "module",
+  "scripts": {
+    "check-attw": "monorepo.tool.attw esm",
+    "check-spelling": "cspell --quiet .",
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "transpile": "monorepo.tool.transpile"
+  }
+}