how to use "Global Query Parameters"

[casualmatt]

How to use the Global Query Parameters, like limit, filter, fields.

            fetchOneDataParams: async function (id: string, collection: string, params: object): Promise<Data> {
                const { getItemById } = useDirectusItems();
                const returnValue = new Data();
                try {
                    returnValue.data = await getItemById({
                        collection: collection,
                        id: id,
                        params:params,
                    });
                } catch (error) {
                    returnValue.error = String(error);
                }
                return returnValue;
            },

my params object is defined in a const, but it doesn't seams to work.

const parameters = {
      fields:[
        "id","status","invoices.number", "invoices.id"
      ]
    }

note: i pass the parameters, id and collection to the function and i check if they ware OK with some old console log.

any suggestion?

[casualmatt]

Also i think that the deep query parameter is not supported.
https://docs.directus.io/reference/query/#deep

nuxt-directus/src/runtime/types/index.d.ts

Lines 42 to 50 in ca57dbd

	export interface DirectusQueryParams {
	fields?: Array<string>;
	sort?: string | Array<string>;
	filter?: Record<string, unknown>;
	limit?: number;
	offset?: number;
	page?: number;
	alias?: string | Array<string>;
	}

[casualmatt]

ok, yes parameters are only implemented on getItems and not on getItemByID

nuxt-directus/src/runtime/composables/useDirectusItems.ts

Lines 25 to 31 in ca57dbd

	const getItemById = async (data: DirectusItemRequest) => {
	const items = await directus(`/items/${data.collection}/${data.id}`, {
	method: "GET",
	});
	// @ts-ignore
	return items.data;

nuxt-directus/src/runtime/composables/useDirectusItems.ts

Lines 11 to 23 in ca57dbd

	const getItems = async (data: DirectusItemRequest) => {
	if (data.params?.filter) {
	// @ts-ignore
	data.params.filter = JSON.stringify(data.params.filter);
	}
	const items = await directus(`/items/${data.collection}`, {
	method: "GET",
	params: data.params,
	});
	// @ts-ignore
	return items.data;
	};

[Intevel]

Yes that's right. For getItemById it wouldn't make sense.

[casualmatt]

It actually does, because one of the main features of directus is this graphql like feature to just fetch some data or related data with one request.
Let's say that i have a dashboard and i want to show some data from various tables that are related to a user.
I can do that with the fields query parameters.

[Intevel]

I will add the query paramters support to getItemById

[casualmatt]

Amazing as always 🤠

[casualmatt]

Hello @Intevel,
got stuck on "Deep" Query Parameters.

EDIT: Sorry cache error forgot to set the env to not cache in dev environment, now it all works

I try with various options:

const parameters = {
  fields: [
    "*",
    "invoices.number",
    "invoices.id",
    "invoices.object",
    "invoices.status",
    "subscriptions.id",
    "subscriptions.status",
    "subscriptions.metadata_title",
  ],
  deep: '{"invoices":{"_limit":3,"_sort":"-created"},"subscriptions":{"_limit":3}}',
};

This first option also has an interesting error shown by VScode, it says that deep doesn't accept a string.

or deep as an object and not as a string, doesn't work.

const parameters = {
  fields: [
    "*",
    "invoices.number",
    "invoices.id",
    "invoices.object",
    "invoices.status",
    "subscriptions.id",
    "subscriptions.status",
    "subscriptions.metadata_title",
  ],
  deep: {
    invoices: { _limit: 3, _sort: "-created" },
    subscriptions: { _limit: 3 },
  },
};