Skip to content

Commit

Permalink
init sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
RajatPawar committed Jan 17, 2025
1 parent 2e5d33a commit 52f1521
Show file tree
Hide file tree
Showing 82 changed files with 11,113 additions and 34 deletions.
28 changes: 28 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* eslint-env node */
module.exports = {
root: true,
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"plugin:import/typescript",
],
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint"],
settings: {
"import/resolver": {
typescript: true,
node: true,
},
},
rules: {
// Handled by typescript compiler
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-explicit-any": "off",
"import/no-named-as-default-member": "off",

"import/no-default-export": "error",
},
};
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.ts linguist-generated=false
29 changes: 29 additions & 0 deletions .github/workflows/sdk_generation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Generate
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
id-token: write
"on":
workflow_dispatch:
inputs:
force:
description: Force generation of SDKs
type: boolean
default: false
set_version:
description: optionally set a specific SDK version
type: string
schedule:
- cron: 0 0 * * *
jobs:
generate:
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
with:
force: ${{ github.event.inputs.force }}
mode: pr
set_version: ${{ github.event.inputs.set_version }}
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
52 changes: 19 additions & 33 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
/models
/models/errors
/types
/node_modules
/lib
/sdk
/funcs
/react-query
/hooks
/index.*
/core.*
/cjs
/esm
/dist
/.tsbuildinfo
/.tshy
/.tshy-*
/__tests__
/.speakeasy/reports
# Logs
logs
*.log
Expand All @@ -6,122 +25,89 @@ yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
Expand Down
14 changes: 14 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts
!/**/*.js
!/**/*.json
!/**/*.map

/.eslintrc.js
/cjs
/.tshy
/.tshy-*
/__tests__
112 changes: 112 additions & 0 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
lockVersion: 2.0.0
id: 9323fb0c-51c0-423a-ae97-da9ff22a9f89
management:
docChecksum: f16bd9d594f7c8c2ca505bbb744f2637
docVersion: 1.0.0
speakeasyVersion: 1.469.0
generationVersion: 2.493.21
releaseVersion: 0.1.1
configChecksum: 23960c4c69fb9d66c87285c94b526dd3
features:
typescript:
acceptHeaders: 2.81.2
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.11
core: 3.18.16
defaultEnabledRetries: 0.1.0
enumUnions: 0.1.0
envVarSecurityUsage: 0.1.2
globalSecurity: 2.82.12
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.4
nameOverrides: 2.81.2
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.2.0
generatedFiles:
- .eslintrc.cjs
- .gitattributes
- .npmignore
- FUNCTIONS.md
- RUNTIMES.md
- USAGE.md
- docs/lib/utils/retryconfig.md
- docs/models/components/security.md
- docs/models/errors/data.md
- docs/models/errors/result.md
- docs/models/errors/writerecordsresponsebody.md
- docs/models/operations/data.md
- docs/models/operations/mode.md
- docs/models/operations/recordt.md
- docs/models/operations/result.md
- docs/models/operations/type.md
- docs/models/operations/writerecordsrequest.md
- docs/models/operations/writerecordsrequestbody.md
- docs/models/operations/writerecordsresponse.md
- docs/models/operations/writerecordsresponsebody.md
- docs/models/operations/writerecordswriteresponsebody.md
- docs/sdks/sdk/README.md
- docs/sdks/write/README.md
- jsr.json
- package.json
- src/core.ts
- src/funcs/writeRecords.ts
- src/hooks/hooks.ts
- src/hooks/index.ts
- src/hooks/types.ts
- src/index.ts
- src/lib/base64.ts
- src/lib/config.ts
- src/lib/dlv.ts
- src/lib/encodings.ts
- src/lib/files.ts
- src/lib/http.ts
- src/lib/is-plain-object.ts
- src/lib/logger.ts
- src/lib/matchers.ts
- src/lib/primitives.ts
- src/lib/retries.ts
- src/lib/schemas.ts
- src/lib/sdks.ts
- src/lib/security.ts
- src/lib/url.ts
- src/models/components/index.ts
- src/models/components/security.ts
- src/models/errors/apierror.ts
- src/models/errors/httpclienterrors.ts
- src/models/errors/index.ts
- src/models/errors/sdkvalidationerror.ts
- src/models/errors/writerecords.ts
- src/models/operations/index.ts
- src/models/operations/writerecords.ts
- src/sdk/index.ts
- src/sdk/sdk.ts
- src/sdk/write.ts
- src/types/blobs.ts
- src/types/constdatetime.ts
- src/types/enums.ts
- src/types/fp.ts
- src/types/index.ts
- src/types/operations.ts
- src/types/rfcdate.ts
- src/types/streams.ts
- tsconfig.json
examples:
writeRecords:
speakeasy-default-write-records:
parameters:
path:
projectIdOrName: "<value>"
integrationId: "<id>"
objectName: "<value>"
requestBody:
application/json: {"groupRef": "<value>", "type": "create", "mode": "synchronous"}
responses:
"200":
application/json: {"result": {"success": true, "recordId": "003Dp0X#@RG7IAP"}}
"422":
application/json: {"errors": ["The record with ID 003Dp0X#@RG7IAP was not found"], "result": {"success": true, "recordId": "003Dp0X#@RG7IAP"}, "warnings": ["Ampersand Operation failed to be updated"], "operationId": "acb0d75a-1b59-4aad-a191-48c5b75ea9e4"}
default:
application/problem+json: {"type": "urn:problem-type:exampleOrganization:exampleProblem", "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types", "title": "Service Unavailable", "status": 503, "detail": "Description of specific occurrence of the problem", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"}
generatedTests: {}
46 changes: 46 additions & 0 deletions .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
configVersion: 2.0.0
generation:
sdkClassName: SDK
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
typescript:
version: 0.1.1
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
author: Speakeasy
clientServerStatusCodesAsErrors: true
defaultErrorName: APIError
enableCustomCodeRegions: false
enableReactQuery: false
enumFormat: union
flattenGlobalSecurity: true
flatteningOrder: parameters-first
imports:
option: openapi
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models/components
webhooks: models/webhooks
inputModelSuffix: input
maxMethodParams: 0
methodArguments: require-security-and-request
moduleFormat: commonjs
outputModelSuffix: output
packageName: openapi
responseFormat: flat
templateVersion: v2
useIndexModules: true
Loading

0 comments on commit 52f1521

Please sign in to comment.