Config sheets & file lifecycle full methods — params · returns · notes

What it does: Read an entire JSON config sheet.

Parameters: fileName - e.g. shop-settings.json, cms-settings.json.

const res = await appifio_client.appifio_readFile('cms-settings.json');
let settings = res.data?.content; // object or ""

Returns: { data: { content: object } } or content: "" if the sheet does not exist yet.

Note: Same function name as AM02 but without id. With id = one ledger row. JSON is already parsed - do not JSON.parse again.

What it does: Overwrite the whole sheet (or create an indexed master when needed).

Parameters: content = JSON string (usually JSON.stringify(obj)). fileType: 'flat' (default) | 'indexed' (create a ledger for append).

await appifio_client.appifio_writeFile(
  'config.json',
  JSON.stringify({ shopName: 'Lan Shop', phone: '090...' })
);

Returns: { success: true }

Note: Do not use this to write individual list rows. System files have their own policy (login.json is rejected). First append often auto-creates the ledger - indexed is not always required.

What it does: Create a new file. Parameters: content string, default ''.

await appifio_client.appifio_createFile('config.json', '{}');

Returns: { success: true } - errors if the name already exists (unlike writeFile, which overwrites).

await appifio_client.appifio_deleteFile('old-config.json');

Returns: { success: true } - soft delete (can restore). To remove one list row → AM02 updateData(..., null), not delete the whole master.

await appifio_client.appifio_restoreFile('old-config.json');

Returns: { success: true } - restores a soft-deleted file.

await appifio_client.appifio_hardDeleteFile('spam.json');

Returns: { success: true }. Note: Permanent delete (including indexed shards) - not undoable.

Parameters: Keep the same extension (e.g. both .json).

await appifio_client.appifio_renameFile('a.json', 'b.json');

Returns: { success: true }

await appifio_client.appifio_copyFile('blog.json', 'blog-backup.json');

Returns: { success: true } - for indexed ledgers, shards are copied too.

const r = await appifio_client.appifio_fileExists('config.json');
// r.data.exists === true | false

Returns: { success: true, data: { exists: true|false } }. Sensitive system files may always report false (no leak).

const r = await appifio_client.appifio_getFileInfo('config.json');
// data: file_name, file_type, file_size, is_deleted, created_at, updated_at

Note: Missing file → success: false (unlike readFile, which can return empty). Prefer fileExists / readFile in most flows.

const r = await appifio_client.appifio_listFiles();
// r.data.files = [{ file_name, file_type, file_size, ... }]
await appifio_client.appifio_listFiles(true); // include soft-deleted - requires login

Note: Hides system files and internal shards. includeDeleted: true only works when an admin is logged in.

Parameters: wildcards *, ? - e.g. blog-*.json.

const r = await appifio_client.appifio_searchFiles('blog-*.json');
// r.data.files = [...]

const r = await appifio_client.appifio_findByName('config.json');
// r.data.files - exact name match

Parameters: fieldPath with dots - e.g. display_formats.date, timezone.

const r = await appifio_client.appifio_readField('cms-settings.json', 'timezone');
// r.data.value - any | null (missing file/field → null)

await appifio_client.appifio_writeField('config.json', 'theme.color', '#ff0000');

Returns: { success: true }. Creates a flat sheet if missing. If value is an object, the system serializes it to JSON for you.