Skip to content

devel.md

Latest commit

 

History

History
88 lines (63 loc) · 2.67 KB

devel.md

File metadata and controls

88 lines (63 loc) · 2.67 KB
Raw

SDK Developer Guide

How to orient yourself in the source code?

  • most of the files are autogenerated by openapitools/openapi-generator-cli
    • please consult ./rebuild.sh script to understand how the automated code generation works
    • autogenerated files contain the following text: This class is auto generated by OpenAPI Generator
    • What is autogenerated?
      • All the api end-point calls implementations (./src/apis)
      • input (request) and output (response) classes (./src/models)
      • common middleware (./src/runtime.ts)
  • small portion of the files in the repo has been hand written by human (without assistance of AI or ML)
    • Top level files like package.json
    • all the readme and examples files
    • middleware for oauth2 and user-agent configuration
    • and ./src/client.ts that is meant to represent an entry point class for end-users (the API imports, property declarations, and constructor assignments are regenerated by scripts/generate_client.py via rebuild.sh; the rest is hand-written)

Checklist before submitting PR

Build typescript in src/ directory to javascript in dist/ directory.

tsc

alternatively you can use npm command to the same

npm run build

Reformat codebase to fit nicely with the rest

npm run format:fix

Ask linter to fix any issues it can fix

npm run lint:fix

Ensure linter output is empty (this checks for issues that cannot be fixed automatically)

npm run lint

How to experiment with SDK under node

The SDK codebase uses fetch API to interface with CrowdStrike Falcon platform. The fetch API while available in browsers is usually not available in node environment. We recommend to install any fetch API alternative. For instance

npm install cross-fetch

In your codebase you then need to pass fetch API implementation down to the Falcon client. Example:

import fetch from "cross-fetch";
import { FalconClient } from "./src";

const client = new FalconClient({
    fetchApi: fetch,
    ...
})

After placing this into ./example.ts you can execute it under node with

tsc && node ./build/example.js

How to update to the latest swagger

  • read & run ./rebuild.sh script

How to release falconjs

  • create a release branch from main (e.g. prepare-1.2.3)
  • bump version in rebuild.sh and src/middleware/useragent.ts
  • bump version in package.json and package-lock.json with npm version {major | minor | patch} --no-git-tag-version
  • run the pre-PR checklist (format:fix, lint:fix, lint, build)
  • commit, push branch, and open a PR targeting main
  • after merge, create a GitHub release on main