npm package: @sassoftware/afcli
Description: This utility generates TypeScript interfaces and client-side code from server-side App Factory Applications (so you don't have to).
Author: SAS
Latest version: 0.8.0

# afcli

`afcli` is a full node JS commandline for interacting with App Factory Cloud apps, functions, and schemas.

It supports two primary commands:
- `create` for creating a create-react-app template for a new React UI that integrates with App Factory cloud API.
- `sync` for generating TypeScript definitions and full interactable hooks for fetching, creating, and using functions and schemas.

Read more about the CLI in our [official documentation](https://appfactory-docs.engage.sas.com/)

## afcli commands

## Creating new projects with afcli

1. Run the `create` command in a directory where you want a new Create SAS App project
```
npx @sassoftware/afcli@latest create
```

## Generate files from an AFC App with afcli

1. Open an App on App Factory Cloud and copy `CSA Sync Command`

Example:
```bash
npx @sassoftware/afcli@latest sync --instance=https://appfactory-<YOUR TEAM>.engage.sas.com --app-id=58 --app-revision=2
```

2. Paste it in terminal and follow the procedure and provide user ID and password for SAS server

3. Files will be created in folder `afcGenerated`, by default.
4. Run command without parameters and start the interactive mode

Example:
```bash
npx @sassoftware/afcli@latest sync
```

### Generate files (offline mode alternative)

Offline mode supports generating TS code without any network connection.
The workflow described above has to contact App Factory to fetch OpenAPI specs
for projects, but they can be downloaded for offline use.

1. Download the OpenAPI specs for all functions and for the schema in the app you wish to generate for.
2. In your local project, create the `.afc` folder if it doesn't already exist.
3. If your app has a schema, move the schema OpenAPI spec to `.afc/customAPISpec/schema.json`. It *must* be named `schema.json`.
4. Add each function OpenAPI spec JSON file to the `.afc/customAPISpec/functions/` folder.
5. Run `@sassoftware/afcli@latest sync` as normal.

You will see the sync command uses the local `.afc` specs provided. 

**Note:** For updates to the definitions, download the new OpenAPI specs and follow the same steps.

For more information and examples please take a look at mock projects in `tests/fixtures`.

## Local Development

You can setup a local version of the CLI using this repo that updates as code changes are made:

```bash
# in the current directory
npm link
```

Once the link is established, the CLI can be run directly:

```sh
afcli --help
```

Note: For dev server all `afcli` initial commands need to be prefixed with OAUTH_CLIENT_ID=''.

Before running the `afcli`, the value of OAUTH_CLIENT_ID has to be replaced with the actual value.

```sh
OAUTH_CLIENT_ID="ENTER_CLIENT_ID" afcli sync --insecure
```

To remove the link, you can simply remove it:


**On linux:** (You may need superuser permission)
```sh
rm $(which afcli)
```

**On windows:**
```bash
# in the repo
npm unlink
```

## Contributions

This project is currently intended for use by participants in the SAS Hackathon. During this event, the repository will refrain from accepting external contributions. However, we have plans to open source the project in the near future, at which point we will welcome contributions from the community.

Please note that after the SAS Hackathon concludes, this notice will be removed, and we will provide updated guidelines for contributing to the project once it becomes open source. We appreciate your understanding and look forward to collaborating with you in the future.