- 707a0ec: Updates JSONSchemaFaker to have the fillProperties option false so it will not make up fake object properties
- b5578b5: fix vscode:// links on Windows (#1058)
- 1af9ec9: Fixes logic in module-tree when a path has multiple wildcard children at the same position
- c586ab8: minor change to REPL: if no action-related argument is passed (--generate, --watch, --serve, --repl), do all of the actions
- e4e1009: If a path is defined at the root (/) it's mapped to index.ts
- 2748fa2: fix: request body type is not found in OpenAPI 2 when consumes is in the root
- fcc9682: support arrays in JSON schema type property (#1005)
- e2f8ac8: Version 1.0!
- e2f8ac8: replaced koa-proxy with koa-proxies to get rid of a deprecation warning (as it turns out, koa-proxies had a different deprecation, but I was able to fix it with patch-package; unfortunately none of the alternatives seem to be currently maintained)
- 48a0c78: ability at runtime for a context object to access other context objects
- c45fcba: New logo! It's not perfect, but the best I can do by myself. If you have graphic design skills, I could use some help cleaning it up.
- 33ccdbf: Update context-registry find logic for bug with mixed path casing
- 4339e42: Fix paths to routes migration
- 0bcf083: fix argument type for .json() (third time's a charm?)
- 11518ab: New file structure - In preparation for the 1.0 release,
pathshas moved toroutes;path-typesandcomponentsare now undertypes. Counterfact will automatically migrate your code for you. We don't like making disruptive changes like this; this will be the last one for the foreseeable future.
- b09fb59: fixed the type system to address that fact that json() handles multiple content types
- 9e285a5: reverted type change for .json() -- it had unintended consequences
- 425e893: turn the proxy on or off for individual paths
- 4fed190: expand the .json() shortcut to include variations of JSON and XML content types
- 88adb61: fixes an issue where imports without a file extension were not transpiled properly
- e355b66: Add command line options for granular control of the different parts of CF
- ab15645: fix #898 hot reloading broken due to cache issues
- 46bd016: option to run Counterfact without OpenAPI (#834)
- 1f44f3d: fixed #721: .proxy on / .proxy off commands in REPL have no effect
- b731a44: fix invalid TypeScript generated for recursive types
- a5a728a: delete the .cache directory at startup so old leftover files don't make trouble
- 678c51b: when a file is changed, all files on which it depends are hot-reloaded (fixes #835)
- bb0a11c: performance fix that should significantly reduce startup time
- 5503a8e: a lot of refactoring of the code that loads modules
- ef57997: fixed: make --prefix work with Swagger
- cb1e12b: move patch-package to dependencies so it won't mess up install
- 1f7bfb9: support for basic auth (
$.auth.username and $ .auth.password)
- d0f6f5a: Updates dispatcher class to ignore case when matching paths
- c4e5ca0: make $ref work everywhere, not just inside schemas (#838)
- d00f6d7: Update usage docs for installing Counterfact as a dependency
- 49733d6: configure JSONSchemaFaker to not fail on invalid types
- 729a8e1: added an announcement about impeding 1.0 release
- b3ab833: fix a type checking issue where the response type has no headers or content
- 30440ae: fixed an edge case with types when the response type has some optional headers
- 9e7923c: strengthen the return type of an operation (the return value of GET(), POST(), etc.)
- f4f377e: useless properties (like $.query when there are no query parameters) are now excluded from types
- b888e11: added a $.x object which is the same as $ but less type safe
- 7f70c2c: added a comment to the top of files under types/paths which links to an FAQ on generated code -- thanks @ingovals for the nudge
- 7b4bdc2: fixed #788: On Windows, the import field from types/paths to context gets wrong slashes while others are fine
- 9601b20: Allows Counterfact to handle requests that contain the OpenApi basePath
- 7e66fba: fix issue where hot reload did not work unless the code is in a package with type: module"
- 5742050: exit gracefully if running Node < 17
- f1c360e: Node >= 17 is now required
- c62b113: If a property is changed in _.context.ts it will override runtime changes (See #747).
-
ef4b6b3: fix an issue in which a file which is essential for type safety was not created (types.d.ts)
-
317fbaa: Fixed and simplified the way
\_.context.tsfiles work.- it's no longer necessary to have a
_.context.tsfile in every directory, only the ones where you want to establish a new context - removed the need for
export type ContextType
- it's no longer necessary to have a
-
6460017: minor breaking change:
$.context.tsis now_.context.tsand exports a class named ContextSee https://github.com/pmcelhaney/counterfact/blob/main/docs/context-change.md
- 8f028d5: CodeGenerator#watch() now waits until Chokidar completes its initial scan before resolving
-
479da6b: transpile TypeScript code to ES2022
-
8ab35b9: emit either CommonJS or ESM files depending on whether there's a package.json with type: module
This change makes it possible to create modules that are imported into files in the paths directory.
- 0610da9: Fix issue 703: Endpoint with trailing slash
- c000cfc: Fixed: a handler function (GET(), PUT(), etc) should always return a response, even if that response is just a status code. If the handler doesn't return, the server will response with a 500 error.
- 4cdcb2d: fix: the optional flag for a parameter was inside quotes, making it part of the name rather than TypeScript syntax
- 47374ee: Partial support for XML (if anyone still uses XML). See https://swagger.io/docs/specification/data-models/representing-xml/
- 2366b50: Removed link to the dashboard / admin console because it's not really useful yet.
- 5c6cce9: Until now the dashboard hasn't gotten much attention. Added a logo and took some baby steps toward the planned design. https://excalidraw.com/#json=THGkyuKCGr_69fFqUrghd,ecIPAvDtoAOajwZ9G4m3sg
- 5c6cce9: fix links to open in VSCode
- 93d7607: added a ⬣> to the prompt to make it look more distinguished
- 960105a: just for fun, the tagline when the CLI starts is different every time you run it
- cf203d7: ignore the HTTP accept header if the response has no body
- 25933c2: fix an issue where the types.d.ts file was not copied over
- 24d96c3: created a new intro banner for the CLI
- 88cebcd: fixed an issue where if there was a directory and file with the same name, one would shadow the other
- 0dc11ea: added a --prefix option to specify prefix from which routes are served (e.g. /api/v1)
- 4de94f0: Update dependency @types/jest to v29.5.7
- 5f8e97b: chore(deps): update dependency @types/jest to v29.5.8
- 0069e9b: The list of routes on on the dashboard (http://localhost:3100/counterfact) is now determined on the fly
- 0069e9b: Regenerate code if the OpenAPI file changes while Counterfact is running
- f89691a: configure json-schema-faker to create between 0 and 20 items when it generates an array
- 33d05f9: configure json-schema-aker to create between 0 and 20 items when it generates an array
- 7eba726: got a little carried away with typeof; it's needed for the instance, not the class
-
836b61d: Fixed an issue where the context object wasn't working as expected.
BREAKING CHANGE:
- the main $.context.ts file needs an extra line:
export type ContextType = Context; - $.context.ts files below the root need to change to
export type { ContextType } from "../$.context"; - if you modified any of the $.context.ts files below the root, treat the first bullet applies
When you run Counterfact, it will try to make these changes for you, so ideally you won't have to worry about it.
- the main $.context.ts file needs an extra line:
- 5f02963: Fixes issue #593 where custom response headers were not being set
- 9d7bc5c: Fixes issue #585 where dispatcher.ts needs to use the matchedPath when calling the contextRegistry.find method
- dd0aecb: remove postinstall script that was preventing counterfact from installing
- 61ba2c9: the server code has been converted to TypeScript -- let me know if something stopped working
- 28d21f8: put generated JS code under a .cache directory and add that directory to .gitignore
- 61ba2c9: fix for OpenAPI 3 examples, which weren't read correctly (hardly anyone uses them)
- 8d86f34: make paths in URLs case-insensitive (http://localhost:3100/FOO is the same as http://localhost:3100/foo)
- f60874f: fix a few edge cases found when running against Github's extensive OpenAPI description: https://github.com/github/rest-api-description
- 7f2e19e: fixed an issue in which routes on the start page weren't rendered correctly in Windows
- 02676a8: Fix typescript-generator importStatements logic for relative paths
- 5523d0f: fixed another bug caused by backslashes in Windows
- 226ce37: fixed a couple more issues in Windows
- 5a9f40a: added a bunch more debug logging
- fix Windows issue where "http://" gets changed to "http:/" and as a result the app hangs
- e1bbb42: added a bit of debug logging (use environment variable DEBUG=counterfact to see it)
- 1ea478a: remove the dependency on ts-node -- path files are now compiled with Typescript and output to a paths-js directory
- 8ef5f41: Windows support! (maybe -- I don't have a Windows machine so I can't test directly)
- 4dcfa06: add CORS headers to support local development (Thanks, dethell-jh!)
- dec64f4: Add CORS headers
- 1d13668: fix an issue where the random() function doesn't recognize it should use OpenAPI2
- 9ca754f: fix another bug where OpenAPI2 puts the produces proprty in the root
- 65f081b: fix error when the produces content type is defined at the root
- 9e0e4d3: it's Friday ¯_(ツ)_/¯
- d975833: fix an issue where ts-node was not being used, which basically broke everything
- 7d05529: fix $.proxy() -- it's better but still experimental
- 74c98aa: Fix: Found an error when headers name contains
-(thanks @hireza!)
- d2a3023: fix issues which made --proxy-url completely broken
- 120eb52: fixes an issue where files may not be treated as ESM
- bb8f5f4: fix an issue causing all endpoints to return 404
- 3c78a07: support for enum values in schemas
- b2bf1db: fix duplicate imports of Context object
- 0f4ead6: don't import HTTPStatusCode if not needed
- 8e4410c: redirect /counterfact to counterfact/
- ab730a8: fix an issue where top-level produces in OpenAPI 2 was not working
- 196f7f4: new
--proxyURL <url>CLI option and.proxy [on|off]command in the REPL
- 1244b6e: support for allOf, anyOf, oneOf, and not
- 1d360bd: OpenAPI 2 -- fall back to top-level produces and consumes
- 052db18: requires ts-node to be installed globally (for now)
- b99a1ed: fault tolerance: the server will not crash due to a syntax error
- b99a1ed: run TypeScript directly via ts-node loader instead of putting JS files on disk
- b7509d9: fix an issue where importing from $.context.ts did not work
- 78c0c31: return $.proxy(url) to proxy to another server
- 6bf3d42:
$context.ts -> $ .context.ts - 7c2893a: change rapidoc configuration to show paths in the nav bar
- 033c067: new landing page with links to Rapidoc and Swagger UI
- 6bf3d42: improve and document the REPL
- a2d6bf0: always start the server regardless of which command line options are present
- 4a96dfa: fix crash when a path is not found
- b177d1d: rebuilt (but very rough) landing page using rapidoc
- 9e457bd: Add OpenApi2 host property support
- 8f472c9: change the way JSONSchemaFaker is imported to avoid CJS -> ESM issues
- 30baae9: a couple of fixes to improve OpenAPI 2 support
- b212793: use OpenAPI to convert strings in path/query/header to numbers at runtime
- e141c46: Experimental support for OpenAPI 2
- 1a622d2: a REPL allows you to interact with the server's context programatically
- 5a7e12b: --open opens the browser to a landing page with pointers to the code, Swagger, and the docs
- f1360ba: made the generated code a bit cleaner
- d8cbc41: fix swagger-ui when the openapi doc has a host property
- d8cbc41: ensure a $context.ts file is created in every directory
- 15270ed: remove dead code in operation-coder.js
- c7a928f: encode non-alphanumeric name as valid variable names
- 02efcd5: fix so that Counterfact no longer depends on itself
- 7e6028c: reworked CLI: generate code then optionally start the server, Swagger UI, open a browser
- Updated dependencies [7e6028c]
- 88ed486: new $context.ts files which are used to define the server context / state
- Updated dependencies [88ed486]
- 920504a: when encoding JSON schema in TypeScript, mark object properties as optional unless they are required
- 92dc769: the open API document can now be loaded from a URL rather than a local path
- ed44ba4: fix so that response[statusCode].random() can use the OpenAPI spec
- 5a767e7: the generated code for a path now uses response[statusCode].random() instead of a bunch of ugly boilerplate
- a1de4c0: add headers to the generated response type
- 86c1412: fix an issue where random() wasn't reading the examples right
- Updated dependencies [a1de4c0]
- Updated dependencies [920504a]
- Updated dependencies [86c1412]
- Updated dependencies [92dc769]
- Updated dependencies [ed44ba4]
- Updated dependencies [5a767e7]
- 4f3c7c9: define a ResponseBuilder type -- to be refined later with one or more generic arguments
- 5f3ee3f: response builder fluent API which is going to make intellisense with TypeScript awesome
- 6221e7d:
counterfact startcommand to start a server - a3dfb48:
npm counterfact init <openapi-file> <destination>command to build a new package with a Counterfact server - 9f91d57: adds a 'go' command that generates code and starts the server in one step
- 25dcd45: ability to respond with multiple content types, return the best match for the request's accept header
- c84a4f4: Counterfact is now able to read an OpenAPI document and use it to generate a random response.
- c0cb938: a function can now return "hello world" as shorthand for
{status: 200, contentType: "text/plain", body: "hello world"}
- 69b4598: replaced EventEmitter with EventTarget
- a07c2b2: fix a crash when regenerating code
- 85c3349: fixed an issue where hot reload did not work in some cases
- 1551cbb: handle additionalProperties when converting a JSON Schema to TypeScript
- 9161d80: Setup basic devcontainer.
- 6d01563: fixed the generate script in the main package (yarn generate wasn't doing anything)
- 6f406c4: fixed an issue where the generated JSON schema was changing integer types to number
- 6f406c4: fixed an issue where a response with no content was blowing up
- 5e72a6c: CLI to generate TypeScript files
- de5e92b: use example values (if present) when generating random data
- ab38cb2: add a tools.randomFromSchema(schema: JSONSchema) function
- 406b907: Add a tools object that will be provided to the request
- 741e4fe: change path parameters from [this] to {this} for consistency with OpenAPI
- f237c38: proof of concept specifying routes with TypeScript and ts-node
- 420cd52: return a 404 with a helpful error message when a handler for a route does not exist
- c11a475: allow the intial context (nee "store") to be passed as the second argument to
counterfact()
- 3829a83: fix changeset access configuration (changesets/changesets#503)
- 4c2bad8: build: add npm token to the release workflow
- 719d932: support for HTTP response code
- a5cd8d4: Filled out missing properties in package.json.
- Deleted the original index.js file that does nothing.
- This is the first release that's actually usable.
- 6101623: Update the demo app to work with recent API changes
- 95f3ca2: no changes -- just trying to get a Github action to run